Struct ArchiveIndex 

pub struct ArchiveIndex { /* private fields */ }

The index of a DwarFS archive representing the whole hierarchy.

This struct is immutable, and is separated from Archive for easier lifetime management.

Use Archive::new to parse and create a pair of ArchiveIndex and Archive.

You usually start at ArchiveIndex::root to get the root directory in the archive and walking or searching on the directory tree. File content can be read via AsChunks, or by manually iterating its Chunks and invokes Chunk::read_cached. You need to supply &mut Archive corresponding to this index only when reading file contents.

Implementations

impl ArchiveIndex

pub fn new_with_config<R: ReadAt + Size>( rdr: &mut SectionReader<R>, config: &Config, ) -> Result<Self>

Parse and create the index of a DwarFS archive.

This is a low-level methods. Usually you should use Archive::new to get a pair of ArchiveIndex and Archive instead.

pub fn root(&self) -> Dir<'_>

Get the root directory of the archive.

pub fn get_path<I>(&self, path: I) -> Option<Inode<'_>>

where I: IntoIterator, I::Item: AsRef<[u8]>,

Get the inode under the given path from the root directory of the archive.

use dwarfs::{ArchiveIndex, Inode};

let index: ArchiveIndex;
// These two statements are equivalent.
let baz1: Inode<'_> = index.get_path("src/lib.rs".split('/'))?;
let baz2: Inode<'_> = index.root().get("src")?.inode().as_dir()?.get("lib.rs")?.inode();

pub fn inodes( &self, ) -> impl ExactSizeIterator<Item = Inode<'_>> + DoubleEndedIterator + '_

Get an iterator over all inodes in the archive, in ascending inode number.

pub fn directories( &self, ) -> impl ExactSizeIterator<Item = Dir<'_>> + DoubleEndedIterator + '_

Get an iterator over all directory inodes in the archive, in ascending inode number.

pub fn get_inode(&self, inode_num: u32) -> Option<Inode<'_>>

Lookup an inode by its inode number.

pub fn section_index(&self) -> &[SectionIndexEntry]

Get the low-level section index.

Trait Implementations

impl Debug for ArchiveIndex

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

Formats the value using the given formatter.