archive_entry_stat (3)

Leading comments

Copyright (c) 2010 Joerg Sonnenberger
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or...

(The comments found at the beginning of the groff file "man3/archive_entry_stat.3".)

NAME

archive_entry_stat archive_entry_copy_stat archive_entry_filetype archive_entry_set_filetype archive_entry_mode archive_entry_set_mode archive_entry_size archive_entry_size_is_set archive_entry_set_size archive_entry_unset_size archive_entry_dev archive_entry_set_dev archive_entry_dev_is_set archive_entry_devmajor archive_entry_set_devmajor archive_entry_devminor archive_entry_set_devminor archive_entry_ino archive_entry_set_ino archive_entry_ino_is_set archive_entry_ino64 archive_entry_set_ino64 archive_entry_nlink archive_entry_rdev archive_entry_set_rdev archive_entry_rdevmajor archive_entry_set_rdevmajor archive_entry_rdevminor archive_entry_set_rdevminor - accessor functions for manipulating archive entry descriptions

LIBRARY

Streaming Archive Library (libarchive, -larchive)

SYNOPSIS

In archive_entry.h Ft const struct stat * Fn archive_entry_stat struct archive_entry *a Ft void Fn archive_entry_copy_stat struct archive_entry *a const struct stat *sb Ft mode_t Fn archive_entry_filetype struct archive_entry *a Ft void Fn archive_entry_set_filetype struct archive_entry *a unsigned int type Ft mode_t Fn archive_entry_mode struct archive_entry *a Ft void Fn archive_entry_set_mode struct archive_entry *a mode_t mode Ft int64_t Fn archive_entry_size struct archive_entry *a Ft int Fn archive_entry_size_is_set struct archive_entry *a Ft void Fn archive_entry_set_size struct archive_entry *a int64_t size Ft void Fn archive_entry_unset_size struct archive_entry *a Ft dev_t Fn archive_entry_dev struct archive_entry *a Ft void Fn archive_entry_set_dev struct archive_entry *a dev_t dev Ft int Fn archive_entry_dev_is_set struct archive_entry *a Ft dev_t Fn archive_entry_devmajor struct archive_entry *a Ft void Fn archive_entry_set_devmajor struct archive_entry *a dev_t major Ft dev_t Fn archive_entry_devminor struct archive_entry *a Ft void Fn archive_entry_set_devminor struct archive_entry *a dev_t minor Ft ino_t Fn archive_entry_ino struct archive_entry *a Ft void Fn archive_entry_set_ino struct archive_entry *a unsigned long ino Ft int Fn archive_entry_ino_is_set struct archive_entry *a Ft int64_t Fn archive_entry_ino64 struct archive_entry *a Ft void Fn archive_entry_set_ino64 struct archive_entry *a int64_t ino Ft unsigned int Fn archive_entry_nlink struct archive_entry *a Ft void Fn archive_entry_set_nlink struct archive_entry *a unsigned int count Ft dev_t Fn archive_entry_rdev struct archive_entry *a Ft dev_t Fn archive_entry_rdevmajor struct archive_entry *a Ft dev_t Fn archive_entry_rdevminor struct archive_entry *a Ft void Fn archive_entry_set_rdev struct archive_entry *a dev_t dev Ft void Fn archive_entry_set_rdevmajor struct archive_entry *a dev_t major Ft void Fn archive_entry_set_rdevminor struct archive_entry *a dev_t minor

DESCRIPTION

Copying to and from Vt struct stat

The function Fn archive_entry_stat converts the various fields stored in the archive entry to the format used by stat(2). The return value remains valid until either Fn archive_entry_clear or Fn archive_entry_free is called. It is not affected by calls to the set accessor functions. It currently sets the following values in Vt struct stat : Vt st_atime , Vt st_ctime , Vt st_dev , Vt st_gid , Vt st_ino , Vt st_mode , Vt st_mtime , Vt st_nlink , Vt st_rdev , Vt st_size , Vt st_uid . In addition, Vt st_birthtime and high-precision information for time-related fields will be included on platforms that support it.

The function Fn archive_entry_copy_stat copies fields from the platform's Vt struct stat . Fields not provided by Vt struct stat are unchanged.

General accessor functions

The functions Fn archive_entry_filetype and Fn archive_entry_set_filetype get respectively set the filetype. The file type is one of the following constants:

AE_IFREG

Regular file

AE_IFLNK

Symbolic link

AE_IFSOCK

Socket

AE_IFCHR

Character device

AE_IFBLK

Block device

AE_IFDIR

Directory

AE_IFIFO

Named pipe (fifo)

Not all file types are supported by all platforms. The constants used by stat(2) may have different numeric values from the corresponding constants above.

The functions Fn archive_entry_mode and Fn archive_entry_set_mode get/set a combination of file type and permissions and provide the equivalent of st_mode Use of Fn archive_entry_filetype and Fn archive_entry_perm for getting and Fn archive_entry_set_filetype and Fn archive_entry_set_perm for setting is recommended.

The function Fn archive_entry_size returns the file size, if it has been set, and 0 otherwise. Fn archive_entry_size can be used to query that status. Fn archive_entry_set_size and Fn archive_entry_unset_size set and unset the size, respectively.

The number of references (hardlinks) can be obtained by calling Fn archive_entry_nlinks and set with Fn archive_entry_set_nlinks .

Identifying unique files

The functions Fn archive_entry_dev and Fn archive_entry_ino64 are used by archive_entry_linkify3 to find hardlinks. The pair of device and inode is supposed to identify hardlinked files.

The device major and minor number can be obtained independently using Fn archive_entry_devmajor and Fn archive_entry_devminor . The device can be set either via Fn archive_entry_set_dev or by the combination of major and minor number using Fn archive_entry_set_devmajor and Fn archive_entry_set_devminor .

The inode number can be obtained using Fn archive_entry_ino . This is a legacy interface that uses the platform Vt ino_t , which may be very small. To set the inode number, Fn archive_entry_set_ino64 is the preferred interface.

Accessor functions for block and character devices

Block and character devices are characterised either using a device number or a pair of major and minor number. The combined device number can be obtained with Fn archive_device_rdev and set with Fn archive_device_set_rdev . The major and minor numbers are accessed by Fn archive_device_rdevmajor , Fn archive_device_rdevminor Fn archive_device_set_rdevmajor and Fn archive_device_set_rdevminor .

The process of splitting the combined device number into major and minor number and the reverse process of combing them differs between platforms. Some archive formats use the combined form, while other formats use the split form.

SEE ALSO

archive_entry_acl3, archive_entry_perms3, archive_entry_time3, libarchive(3), stat(2)