Struct compressed_vec::vector::VectorReader

pub struct VectorReader<'buf, T: VectBase> { /* fields omitted */ }

A reader for reading sections and elements from a VectorAppender written vector. Use the same base type - eg VectorU32Appender -> VectorReader:: Can be reused many times; it has no mutable state and creates new iterators every time.

Implementations

impl<'buf, T> VectorReader<'buf, T> where
    T: VectBase + BaseSubtypeMapping, 

pub fn try_new(vect_bytes: &'buf [u8]) -> Result<Self, CodingError>

Creates a new reader out of the bytes for the vector.

pub fn num_elements(&self) -> usize

pub fn total_bytes(&self) -> usize

pub fn num_null_sections(&self) -> Result<usize, CodingError>

Iterates and discovers the number of null sections. O(num_sections). It will be faster to just use get_stats().

pub fn get_stats(&self) -> FixedSectStats

Returns a FixedSectStats extracted from the vector header.

pub fn sect_iter(&self) -> FixedSectIterator<'buf, T>

Returns an iterator over each section in this vector

pub fn filter_iter<F: SectFilterSink<T>>(
    &self,
    f: F
) -> VectorFilter<'buf, F, T>

Returns a VectorFilter that iterates over 256-bit masks filtered from vector elements

pub fn iterate(&self) -> VectorItemIter<'buf, T>

Returns an iterator over all items in this vector.

pub fn decode_to_sink<Output>(
    &self,
    output: &mut Output
) -> Result<(), CodingError> where
    Output: Sink<T::SI>, 

Decodes/processes this vector's elements through a Sink. This is the most general purpose vector decoding/processing API.