Struct Directory 

pub struct Directory {
    pub descriptors: Vec<ChunkDescriptor>,
}

The chunk directory: one descriptor per chunk, in file order.

Fields

descriptors: Vec<ChunkDescriptor>

Every descriptor, including null ones.

Implementations

impl Directory

pub fn new() -> Self

An empty directory.

pub fn entries(&self) -> impl Iterator<Item = &ChunkDescriptor>

Non-null chunks, in file order.

pub fn find_all( &self, chunk_type: ChunkType, ) -> impl Iterator<Item = &ChunkDescriptor>

Non-null chunks carrying chunk_type, in file order.

pub fn find(&self, chunk_type: ChunkType) -> Option<&ChunkDescriptor>

The first non-null chunk of chunk_type.

Where the specification says a chunk appears at most once (PROF, LROV, VOXL, ZDIC), readers use the first.

pub fn contains(&self, chunk_type: ChunkType) -> bool

Whether any non-null chunk carries chunk_type.

pub fn first_entry_index(&self) -> Option<usize>

The index of the first non-null descriptor, i.e. the first chunk.

pub fn push(&mut self, descriptor: ChunkDescriptor)

Push a descriptor.

pub fn to_bytes(&self) -> Vec<u8>

Serialize every descriptor, in order.

pub fn total_uncompressed_size(&self) -> u64

The sum of every non-null chunk’s size_uncompressed.

Trait Implementations

impl Clone for Directory

fn clone(&self) -> Directory

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Directory

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

Formats the value using the given formatter.

impl Default for Directory

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Directory

impl PartialEq for Directory

fn eq(&self, other: &Directory) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Directory