Struct Archive 

pub struct Archive<R: ?Sized> { /* private fields */ }

A DwarFS archive wrapping reader R.

Usually, you create a pair of Archive and ArchiveIndex using Archive::new. Directory hierarchy traversal can be done only on ArchiveIndex, and this struct is only needed for reading file content.

See also ArchiveIndex.

Implementations

impl<R: ReadAt + Size> Archive<R>

pub fn new(rdr: R) -> Result<(ArchiveIndex, Self)>

Load a DwarFS archive from a random-access stream, typically a std::fs::File.

Note 1: Do not use BufReader, because Archive already has internal caches. Use Config::block_cache_size_limit to configure its size.

Note 2: It’s discouraged to use positioned_io::RandomAccessFile on *NIX platforms because that would disable readahead which can hurt performance on sequential read inside a several MiB section. On Windows, however, RandomAccessFile is several times faster than File.

pub fn new_with_config(rdr: R, config: &Config) -> Result<(ArchiveIndex, Self)>

Same as Archive::new but with a non-default Config.

pub fn new_with_index_and_config( rdr: SectionReader<R>, index: &ArchiveIndex, config: &Config, ) -> Result<Self>

The low-level method for creating an Archive with already parsed ArchiveIndex.

impl<R> Archive<R>

pub fn into_inner(self) -> R

where R: Sized,

Retrieve the ownership of the underlying reader.

pub fn get_ref(&self) -> &R

Get a reference to the underlying reader.

pub fn get_mut(&mut self) -> &mut R

Get a mutable reference to the underlying reader.

Trait Implementations

impl<R: Debug + ?Sized> Debug for Archive<R>

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

Formats the value using the given formatter.