Struct File

pub struct File<'archive> { /* private fields */ }

A file in a squashfs archive.

Note that directories, symlinks, and other special files are also represented as File.

Files are created from an Archive with e.g. Archive::open.

Implementations

impl<'archive> File<'archive>

pub fn file_type(&self) -> Option<FileType>

Returns the type of the file.

pub fn permissions(&self) -> Permissions

Returns the permissions of the file.

pub fn inode_ref(&self) -> InodeRef

Returns the inode reference of the file.

This can for example be used to re-open the file with Archive::open_ref.

pub fn is_extended(&self) -> bool

Returns whether the file is an extended structure

pub fn hard_link_count(&self) -> u32

Getter for the inode hard link count

pub fn size(&self) -> u64

Getter for the file size. 0 if the file has no size.

pub fn inode(&self) -> Inode

Getter for the inode number.

pub fn parent_inode(&self) -> Inode

Getter for the inode number of the parent directory.

pub fn follow_symlink(&mut self) -> Result<()>

Follow a single symbolic link.

After calling this function, the file is (in-place) changed to the target of the symlink.

pub fn follow_all_symlinks(&mut self) -> Result<()>

Follow symlink targets recursively until a non-symlink file is found.

After calling this function, the file is (in-place) changed to the target of the symlink(s).

This function performs recursion detection and will return an error if a symlink loop is detected.

pub fn modified_time(&self) -> u32

Getter for the modification time.

Returns the number of seconds since the Unix epoch.

pub fn symlink_path(&self) -> Option<&BStr>

Symbolic link target path.

If this file is not a symbolic link, this will return None.

pub fn device_id(&self) -> u32

Returns the device id of the device inode.

pub fn uid(&self) -> u32

Returns the owner user id of the file.

pub fn gid(&self) -> u32

Returns the owner group id of the file.

pub fn xattr_id(&self) -> u32

Returns index of the extended attribute inside of the xattr table.

pub fn as_dir(&self) -> Result<DirectoryIterator<'_, 'archive>>

Returns an iterator over the directory entries of the file.

If the file is not a directory, this will return an error.

pub fn xattrs(&self) -> Result<XattrIterator<'_>>

Returns an iterator over the extended attributes of the file.

pub fn reader(&self) -> Result<Reader<'_>>

Returns a new reader for the file.

pub fn traversal(&self) -> Result<Traversal<'_>>

Returns a new traversal for the file.

A traversal is used to recursively traverse the file tree starting from this file/directory.

Trait Implementations

impl<'archive> Debug for File<'archive>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'archive> Drop for File<'archive>

fn drop(&mut self)

Executes the destructor for this type.

impl<'archive> Send for File<'archive>

impl<'archive> Sync for File<'archive>