Struct litetx::Decoder

pub struct Decoder<'a, R>where
    R: Read,{ /* private fields */ }

An LTX file decoder.

Example

let (mut dec, header) = litetx::Decoder::new(r).expect("decoder");

let mut buf = vec![0; header.page_size.into_inner() as usize];
while let Some(page_num) = dec.decode_page(&mut buf).expect("decode_page") {
    // do something with the page
}

let trailer = dec.finish().expect("finish");

Implementations

impl<'a, R> Decoder<'a, R>where R: Read,

pub fn new(r: R) -> Result<(Decoder<'a, R>, Header), Error>

Construct a new Decoder that reads from r.

pub fn decode_page(&mut self, data: &mut [u8]) -> Result<Option<PageNum>, Error>

Decode the next page from the LTX file.

Returns Ok(Some(page_num)) if a page has been successfully decoded. Return Ok(None) if the LTX file doesn’t have any more pages.

pub fn finish(self) -> Result<Trailer, Error>

Consume the decoder and verify file checksum.