Struct ArchiveReader 

pub struct ArchiveReader<R> { /* private fields */ }

A random-access ZArchive reader.

Implementations

impl ArchiveReader<File>

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Opens an archive from the filesystem.

impl<R: Read + Seek> ArchiveReader<R>

pub fn new(source: R) -> Result<Self>

Opens an archive from any readable, seekable source.

pub fn lookup(&self, path: impl AsRef<[u8]>) -> Option<NodeHandle>

Returns the node at path, using ASCII case-insensitive matching.

pub fn lookup_kind( &self, path: impl AsRef<[u8]>, expected: Option<EntryKind>, ) -> Option<NodeHandle>

Returns the node at path only if it has the requested kind.

pub fn archive_size(&self) -> u64

The total size of the archive file, including its tables and footer.

pub fn compressed_data_size(&self) -> u64

The size of the compressed data section, excluding the tables and footer.

pub fn entry_kind(&self, handle: NodeHandle) -> Option<EntryKind>

pub fn directory_len(&self, handle: NodeHandle) -> Result<u32>

pub fn directory_entry( &self, handle: NodeHandle, index: u32, ) -> Result<DirEntry<'_>>

pub fn directory_entries(&self, handle: NodeHandle) -> Result<Vec<DirEntry<'_>>>

pub fn file_size(&self, handle: NodeHandle) -> Result<u64>

pub fn read_file( &mut self, handle: NodeHandle, offset: u64, buffer: &mut [u8], ) -> Result<usize>

Reads at most buffer.len() bytes beginning at an offset within a file.

pub fn read_file_to_end(&mut self, handle: NodeHandle) -> Result<Vec<u8>>

Reads an entire archived file into memory.

pub fn verify_integrity(&mut self) -> Result<bool>

Verifies the SHA-256 digest stored in the archive footer.

pub fn verify_integrity_with( &mut self, progress: impl FnMut(u64), ) -> Result<bool>

Verifies the footer digest, reporting bytes hashed as it goes.

progress is called with the size of each chunk as it is consumed, so callers can drive a progress indicator over what is otherwise a single long pass across the whole file.

pub fn into_inner(self) -> R