archive_entry_stat, archive_entry_copy_stat, archive_entry_filetype, archive_entry_set_filetype,
Contents
Description
Copyingtoandfromstructstat
The function 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 archive_entry_clear() or
archive_entry_free() is called. It is not affected by calls to the set accessor functions. It currently
sets the following values in structstat: st_atime, st_ctime, st_dev, st_gid, st_ino, st_mode, st_mtime,
st_nlink, st_rdev, st_size, st_uid. In addition, st_birthtime and high-precision information for time-
related fields will be included on platforms that support it.
The function archive_entry_copy_stat() copies fields from the platform's structstat. Fields not
provided by structstat are unchanged.
Generalaccessorfunctions
The functions archive_entry_filetype() and 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 archive_entry_mode() and archive_entry_set_mode() get/set a combination of file type and
permissions and provide the equivalent of st_mode. Use of archive_entry_filetype() and
archive_entry_perm() for getting and archive_entry_set_filetype() and archive_entry_set_perm() for
setting is recommended.
The function archive_entry_size() returns the file size, if it has been set, and 0 otherwise.
archive_entry_size() can be used to query that status. archive_entry_set_size() and
archive_entry_unset_size() set and unset the size, respectively.
The number of references (hardlinks) can be obtained by calling archive_entry_nlink() and set with
archive_entry_set_nlink().
Identifyinguniquefiles
The functions archive_entry_dev() and archive_entry_ino64() are used by archive_entry_linkify(3) 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 archive_entry_devmajor() and
archive_entry_devminor(). The device can be set either via archive_entry_set_dev() or by the combination
of major and minor number using archive_entry_set_devmajor() and archive_entry_set_devminor().
The inode number can be obtained using archive_entry_ino(). This is a legacy interface that uses the
platform ino_t, which may be very small. To set the inode number, archive_entry_set_ino64() is the
preferred interface.
Accessorfunctionsforblockandcharacterdevices
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 archive_device_rdev() and set with
archive_device_set_rdev(). The major and minor numbers are accessed by archive_device_rdevmajor(),
archive_device_rdevminor() archive_device_set_rdevmajor() and 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.
Library
Streaming Archive Library (libarchive, -larchive)
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
See Also
stat(2), archive_entry_acl(3), archive_entry_perms(3), archive_entry_time(3), libarchive(3)
Debian February 2, 2012 ARCHIVE_ENTRY_STAT(3)
Synopsis
#include<archive_entry.h>conststructstat*archive_entry_stat(structarchive_entry*a);
voidarchive_entry_copy_stat(structarchive_entry*a, conststructstat*sb);
mode_tarchive_entry_filetype(structarchive_entry*a);
voidarchive_entry_set_filetype(structarchive_entry*a, unsignedinttype);
mode_tarchive_entry_mode(structarchive_entry*a);
voidarchive_entry_set_mode(structarchive_entry*a, mode_tmode);
int64_tarchive_entry_size(structarchive_entry*a);
intarchive_entry_size_is_set(structarchive_entry*a);
voidarchive_entry_set_size(structarchive_entry*a, int64_tsize);
voidarchive_entry_unset_size(structarchive_entry*a);
dev_tarchive_entry_dev(structarchive_entry*a);
voidarchive_entry_set_dev(structarchive_entry*a, dev_tdev);
intarchive_entry_dev_is_set(structarchive_entry*a);
dev_tarchive_entry_devmajor(structarchive_entry*a);
voidarchive_entry_set_devmajor(structarchive_entry*a, dev_tmajor);
dev_tarchive_entry_devminor(structarchive_entry*a);
voidarchive_entry_set_devminor(structarchive_entry*a, dev_tminor);
ino_tarchive_entry_ino(structarchive_entry*a);
voidarchive_entry_set_ino(structarchive_entry*a, unsignedlongino);
intarchive_entry_ino_is_set(structarchive_entry*a);
int64_tarchive_entry_ino64(structarchive_entry*a);
voidarchive_entry_set_ino64(structarchive_entry*a, int64_tino);
unsignedintarchive_entry_nlink(structarchive_entry*a);
voidarchive_entry_set_nlink(structarchive_entry*a, unsignedintcount);
dev_tarchive_entry_rdev(structarchive_entry*a);
dev_tarchive_entry_rdevmajor(structarchive_entry*a);
dev_tarchive_entry_rdevminor(structarchive_entry*a);
voidarchive_entry_set_rdev(structarchive_entry*a, dev_tdev);
voidarchive_entry_set_rdevmajor(structarchive_entry*a, dev_tmajor);
voidarchive_entry_set_rdevminor(structarchive_entry*a, dev_tminor);
