Struct riff::Chunk

pub struct Chunk { /* fields omitted */ }

A chunk, also known as a form

Implementations

impl Chunk

pub fn id(&self) -> ChunkId

Returns the ChunkId of this chunk.

pub fn len(&self) -> u32

Returns the number of bytes in this chunk.

pub fn offset(&self) -> u64

Returns the offset of this chunk from the start of the stream.

pub fn read_type<T>(&self, stream: &mut T) -> Result<ChunkId> where
    T: Read + Seek, 

Reads the chunk type of this chunk.

Generally only valid for RIFF and LIST chunks.

pub fn read<T>(stream: &mut T, pos: u64) -> Result<Chunk> where
    T: Read + Seek, 

Reads a chunk from the specified position in the stream.

pub fn read_contents<T>(&self, stream: &mut T) -> Result<Vec<u8>> where
    T: Read + Seek, 

Reads the entirety of the contents of a chunk.

pub fn iter<'a, T>(&self, stream: &'a mut T) -> Iter<'a, T>ⓘ

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> where
    T: Seek + Read,  type Item = Chunk;

where
    T: Seek + Read, 

Returns an iterator over the children of the chunk.

If the chunk has children but is noncompliant, e.g. it has no type identifier (like seqt chunks), use iter_no_type instead.

pub fn iter_no_type<'a, T>(&self, stream: &'a mut T) -> Iter<'a, T>ⓘ

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> where
    T: Seek + Read,  type Item = Chunk;

where
    T: Seek + Read, 

Returns an iterator over the chilren of the chunk. Only valid for noncompliant chunks that have children but no chunk type identifier (like seqt chunks).

Trait Implementations

impl Debug for Chunk

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

Formats the value using the given formatter.

impl Eq for Chunk

impl PartialEq<Chunk> for Chunk

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Chunk

impl StructuralPartialEq for Chunk