Struct Chunk 

pub struct Chunk { /* private fields */ }

Chunk meta-data. This doesn’t contain contents or children, but information needed to read the chunk from a file. You will still need a reader to read the contents though.

Implementations

impl Chunk

pub fn read<R: Read + Seek>(reader: R) -> Result<Self, ReadError>

Reads the chunk header and returns the information needed to read its contents or children.

pub fn content<R: Read + Seek>( &self, reader: R, ) -> Result<ContentReader<R>, ReadError>

Creates a reader for its contents.

pub fn read_content_to_vec<R: Read + Seek>( &self, reader: R, ) -> Result<Vec<u8>, ReadError>

pub fn children<R: Read + Seek>(&self, reader: R) -> ChildrenReader<R>

Creates an iterator over its children. The iterator yields Result<Chunk, _>, so you’ll need to handle the error first. Each child then is another Chunk struct that can be used to read contents or children.

pub fn offset(&self) -> u32

Returns the offset at which the chunk starts. This is relative to the start of the reader. Note that for children chunks, this is relative to the start of the child data, since they basically use a ContentReader to read children chunks.

pub fn id(&self) -> ChunkId

Returns the chunk IDs

pub fn content_offset(&self) -> u32

Returns the offset to the content data. See Self::offset for further information.

pub fn content_len(&self) -> u32

Returns the length of the content data.

pub fn children_offset(&self) -> u32

Returns the offset to the children data. See Self::offset for further information.

pub fn children_len(&self) -> u32

Returns the length of the children data.

pub fn len(&self) -> u32

Returns the length of this chunk. That is the length of its contents, children and header.

pub fn is_empty(&self) -> bool

Returns true if the chunks has neither content nor children, false otherwise.

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Chunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.