Struct Vector

pub struct Vector<'buf, T: ?Sized> { /* private fields */ }

A slice-like view into a serialized flatbuffer that deserializes on demand.

Implementations

impl<'buf, T: ?Sized> Vector<'buf, T>

pub const fn new_empty() -> Vector<'buf, T>

Returns an empty Vector

This is typically not very useful, since the vector is read-only, but has uses for instance as a default value.

pub fn is_empty(self) -> bool

Checks if the vector is empty.

pub fn len(self) -> usize

Returns the number of elements in the vector.

impl<'buf, T: VectorRead<'buf>> Vector<'buf, T>

pub fn first(self) -> Option<T>

Returns the first element of the Vector, or None if it is empty.

pub fn last(self) -> Option<T>

Returns the last element of the Vector, or None if it is empty.

pub fn get<I>(self, index: I) -> Option<I::Output>

where I: VectorIndex<'buf, T>,

Returns an element or sub-vector depending on the type of index.

• If given a position, returns the element at that position or None if out of bounds.
• If given a range, returns the sub-vector corresponding to that range, or None if out of bounds.

pub unsafe fn get_unchecked<I>(self, index: I) -> I::Output

where I: VectorIndex<'buf, T>,

Returns an element or sub-vector, without doing bounds checking.

For a safe alternative see get.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting output is not used.

pub fn iter(self) -> Iter<'buf, T>

Returns an iterator over the vector.

pub fn chunks(self, chunk_size: usize) -> Chunks<'buf, T>

Returns an iterator over chunk_size elements of the Vector at a time, starting at the beginning of the vector.

The chunks are Vectors themselves and do not overlap. If chunk_size does not divide the length of the Vector, then the last chunk will not have length chunk_size.

See chunks_exact for a variant of this iterator that returns chunks of always exactly chunk_size elements, and rchunks for the same iterator but starting at the end of the vector.

Panics

Panics if chunk_size is 0.

pub fn rchunks(self, chunk_size: usize) -> RChunks<'buf, T>

Returns an iterator over chunk_size elements of the Vector at a time, starting at the end of the vector.

The chunks are Vectors themselves and do not overlap. If chunk_size does not divide the length of the Vector, then the last chunk will not have length chunk_size.

See rchunks_exact for a variant of this iterator that returns chunks of always exactly chunk_size elements, and chunks for the same iterator but starting at the beginning of the vector.

Panics

Panics if chunk_size is 0.

pub fn chunks_exact(self, chunk_size: usize) -> ChunksExact<'buf, T>

Returns an iterator over chunk_size elements of the Vector at a time, starting at the beginning of the vector.

The chunks are Vectors themselves and do not overlap. If chunk_size does not divide the length of the vector, then the last up to chunk_size-1 elements will be omitted and can be retrieved from the remainder function of the iterator.

Due to each chunk having exactly chunk_size elements, the compiler can often optimize the resulting code better than in the case of chunks.

See chunks for a variant of this iterator that also returns the remainder as a smaller chunk, and rchunks_exact for the same iterator but starting at the end of the vector.

Panics

Panics if chunk_size is 0.

pub fn rchunks_exact(self, chunk_size: usize) -> RChunksExact<'buf, T>

Returns an iterator over chunk_size elements of the Vector at a time, starting at the end of the vector.

The chunks are Vectors themselves and do not overlap. If chunk_size does not divide the length of the vector, then the last up to chunk_size-1 elements will be omitted and can be retrieved from the remainder function of the iterator.

Due to each chunk having exactly chunk_size elements, the compiler can often optimize the resulting code better than in the case of rchunks.

See rchunks for a variant of this iterator that also returns the remainder as a smaller chunk, and chunks_exact for the same iterator but starting at the beginning of the vector.

Panics

Panics if chunk_size is 0.

pub fn windows(self, size: usize) -> Windows<'buf, T>

Returns an iterator over all contiguous windows of length size. The windows overlap. If the vector is shorter than size, the iterator returns no values.

Panics

Panics if size is 0.

pub fn split_first(self) -> Option<(T, Vector<'buf, T>)>

Returns the first and all the rest of the elements of the Vector, or None if it is empty

pub fn split_last(self) -> Option<(T, Vector<'buf, T>)>

Returns the last and all the rest of the elements of the Vector, or None if it is empty

pub fn split_at(self, mid: usize) -> Option<(Vector<'buf, T>, Vector<'buf, T>)>

Divides one Vector into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

pub unsafe fn split_at_unchecked( self, mid: usize, ) -> (Vector<'buf, T>, Vector<'buf, T>)

Divides one Vector into two at an index, without doing bounds checking.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

For a safe alternative see split_at.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting output is not used. The caller has to ensure that 0 <= mid <= self.len().

impl<'buf, T: VectorRead<'buf>> Vector<'buf, T>

pub fn to_vec<O>(self) -> Result<Vec<O>>

where O: TryFrom<T>, Error: From<O::Error>,

Copies self into a new Vec.

impl<'buf, T, E> Vector<'buf, Result<T, E>>

pub fn to_vec_result<O>(self) -> Result<Vec<O>>

where T: VectorReadInner<'buf>, E: From<T::Error>, O: TryFrom<T>, Error: From<E> + From<O::Error>,

Copies self into a new Vec.

Trait Implementations

impl<'buf, T: ?Sized> Clone for Vector<'buf, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'buf, T> Debug for Vector<'buf, T>

where T: Debug + VectorRead<'buf>,

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

Formats the value using the given formatter.

impl<'buf, T: VectorRead<'buf>> IntoIterator for Vector<'buf, T>

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<'buf, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'buf, T: VectorRead<'buf>, O> TryFrom<Vector<'buf, T>> for Vec<O>

where O: TryFrom<T>, Error: From<O::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vector<'buf, T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'buf, T: ?Sized> Copy for Vector<'buf, T>