Struct RandomAccessBinaryCollection 

pub struct RandomAccessBinaryCollection<'a> { /* private fields */ }

A version of BinaryCollection with random access to sequences.

Because the binary format underlying BinaryCollection does not support random access, implementing it requires precomputing memory offsets for the sequences, and storing them in the struct. This means RandomAccessBinaryCollection::try_from will have to perform one full pass through the entire collection to collect the offsets. Thus, use this class only if you need the random access functionality.

Note that the because offsets are stored within the struct, it is not Copy as opposed to BinaryCollection, which is simply a view over a memory buffer.

Examples

let mut buffer: Vec<u8> = Vec::new();
encode_u32_sequence(&mut buffer, 3, &[1, 2, 3])?;
encode_u32_sequence(&mut buffer, 1, &[4])?;
encode_u32_sequence(&mut buffer, 3, &[5, 6, 7])?;

let mut collection = RandomAccessBinaryCollection::try_from(&buffer[..])?;
assert_eq!(
    collection.get(0).map(|seq| seq.iter().collect::<Vec<_>>()),
    Some(vec![1_u32, 2, 3]),
);
assert_eq!(
    collection.at(2).iter().collect::<Vec<_>>(),
    vec![5_u32, 6, 7],
);
assert_eq!(collection.get(3), None);

collection.at(3); // out of bounds

Implementations

impl<'a> RandomAccessBinaryCollection<'a>

pub fn iter( &self, ) -> impl Iterator<Item = Result<BinarySequence<'a>, InvalidFormat>>

Returns an iterator over sequences.

pub fn at(&self, index: usize) -> BinarySequence<'a>

Returns the sequence at the given index.

Panics

Panics if the index is out of bounds.

pub fn get(&self, index: usize) -> Option<BinarySequence<'a>>

Returns the sequence at the given index or None if out of bounds.

pub fn len(&self) -> usize

Returns the number of sequences in the collection.

pub fn is_empty(&self) -> bool

Checks if the collection is empty.

Trait Implementations

impl<'a> Clone for RandomAccessBinaryCollection<'a>

fn clone(&self) -> RandomAccessBinaryCollection<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RandomAccessBinaryCollection<'a>

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

Formats the value using the given formatter.

impl<'a> TryFrom<&'a [u8]> for RandomAccessBinaryCollection<'a>

type Error = InvalidFormat

The type returned in the event of a conversion error.

fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.