Struct FileEntry

pub struct FileEntry<'a, B: Backend>(/* private fields */);

A file entry of the archive.

An instance of this type is attached to the Entry::File variant and provides file specific options.

One of the read* methods can be used to get the content of the file.

Implementations

impl<'a, B: Backend> FileEntry<'a, B>

pub fn name(&self) -> &str

Returns the name of the file.

pub fn size(&self) -> u64

Returns the size of the file.

pub fn can_read(&self, group: Group) -> bool

Tests whether a member of the given group has read access.

pub fn can_write(&self, group: Group) -> bool

Tests whether a member of the given group has write access.

pub fn can_execute(&self, group: Group) -> bool

Tests whether a member of the given group has execute access.

pub fn appended(&self) -> &DateTime<Utc>

Returns the time when the entry was appened to the archive.

pub fn created(&self) -> &DateTime<Utc>

Returns the time when the originating filesystem entry was created.

pub fn changed(&self) -> &DateTime<Utc>

Returns the time when the originating filesystem entry was changed the last time.

pub fn modified(&self) -> &DateTime<Utc>

Returns the time when the originating filesystem entry was modified the last time.

pub fn read(&mut self, buf: &mut [u8]) -> ArchiveResult<usize, B>

Reads data from the entry.

Reads up to buf.len() bytes and puts them into buf.

The methods returns the number of bytes actually read, which cannot be greater than the buf.len().

pub fn read_all(&mut self, buf: &mut [u8]) -> ArchiveResult<(), B>

Read the exact number of bytes required to fill buf

This function reads as many bytes as necessary to completely fill the specified buffer buf.

Errors

If this function encounters an “end of file” before completely filling the buffer, it returns an Error::UnexpectedEof error. The contents of buf are unspecified in this case.

pub fn read_vec(&mut self) -> ArchiveResult<Vec<u8>, B>

Reads all bytes until EOF and collects them into a Vec which is returned.