Struct bdf::io::BDFReader

pub struct BDFReader {
    pub metadata: Option<MetaChunk>,
    pub lookup_table: Option<HashLookupTable>,
    // some fields omitted
}

Fields

metadata: Option<MetaChunk>

lookup_table: Option<HashLookupTable>

Methods

impl BDFReader

pub fn new(inner: File) -> Self

Creates a new BDFReader

pub fn read_start(&mut self) -> Result<(), Error>

Reads the metadata and lookup table

pub fn read_metadata(&mut self) -> Result<&MetaChunk, Error>

Verifies the header of the file and reads and stores the metadata

pub fn read_lookup_table(&mut self) -> Result<&HashLookupTable, Error>

Reads the lookup table of the file. This function should be called after the read_metadata function was called

pub fn next_chunk(&mut self) -> Result<GenericChunk, Error>

Returns the next chunk if one is available.