Enum ControlWordIterator

pub enum ControlWordIterator {
    Binary8(BinaryControlWordIterator<Zip<IntoIter<u16>, IntoIter<u16>>, u8>),
    Binary16(BinaryControlWordIterator<Zip<IntoIter<u16>, IntoIter<u16>>, u16>),
    Binary32(BinaryControlWordIterator<Zip<IntoIter<u16>, IntoIter<u16>>, u32>),
    Unary8(UnaryControlWordIterator<IntoIter<u16>, u8>),
    Unary16(UnaryControlWordIterator<IntoIter<u16>, u16>),
    Unary32(UnaryControlWordIterator<IntoIter<u16>, u32>),
    Nilary(NilaryControlWordIterator),
}

An iterator that generates control words from repetition and definition levels

“Control word” is just a fancy term for a single u8/u16/u32 that contains both the repetition and definition in it.

In the large majority of case we only need a single byte to represent both the repetition and definition levels. However, if there is deep nesting then we may need two bytes. In the worst case we need 4 bytes though this suggests hundreds of levels of nesting which seems unlikely to encounter in practice.

Variants

Binary8(BinaryControlWordIterator<Zip<IntoIter<u16>, IntoIter<u16>>, u8>)

Binary16(BinaryControlWordIterator<Zip<IntoIter<u16>, IntoIter<u16>>, u16>)

Binary32(BinaryControlWordIterator<Zip<IntoIter<u16>, IntoIter<u16>>, u32>)

Unary8(UnaryControlWordIterator<IntoIter<u16>, u8>)

Unary16(UnaryControlWordIterator<IntoIter<u16>, u16>)

Unary32(UnaryControlWordIterator<IntoIter<u16>, u32>)

Nilary(NilaryControlWordIterator)

Implementations

impl ControlWordIterator

pub fn append_next(&mut self, buf: &mut Vec<u8>)

Appends the next control word to the buffer

pub fn bytes_per_word(&self) -> usize

Returns the number of bytes per control word

pub fn bits_rep(&self) -> u8

Returns the number of bits used for the repetition level

pub fn bits_def(&self) -> u8

Returns the number of bits used for the definition level

Trait Implementations

impl Debug for ControlWordIterator

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

Formats the value using the given formatter.