Struct fixed_capacity_vec::FixedCapacityVec

pub struct FixedCapacityVec<T, const N: usize> { /* private fields */ }

Like Vec with a capacity fixed at compile time

When full, can be converted without copying into Box<[T; N]>, using TryFrom.

Comparison with related data types

All of the following types store only the actual buffer on the heap, and they are interconvertible without copying the data.

Type	Size and representation (as eg on stack)	Full?	Mutability
Vec	3 words: pointer, length, capacity	maybe	indefinitely appendable
Box<[T]>	2 words: pointer, length = capacity	always	length fixed at runtime
FixedCapacityVec<[T; N]>	2 words: pointer, length	maybe	appendable, but capacity fixed at compile time
Box<[T; N]>	1 word: pointer	always	length fixed at compile time

Implementations

impl<T, const N: usize> FixedCapacityVec<T, N>

pub fn new() -> Self

Create a new empty FixedCapacityVec, capable of holding up to N values of type T

pub fn len(&self) -> usize

Return the number of values stored so far

pub fn is_empty(&self) -> bool

Returns true iff the FixedCapacityVec is empty

pub fn is_full(&self) -> bool

Returns true iff the FixedCapacityVec is full - ie, it has N elements

pub fn push(&mut self, item: T)

Append an element

Panics

Panics if the FixedCapacityVec is full, ie if it already contains N elements

Trait Implementations

impl<T, const N: usize> Drop for FixedCapacityVec<T, N>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, const N: usize> TryFrom<FixedCapacityVec<T, N>> for Box<[T; N]>

Convert a full FixedCapacityVec into a boxed array.

If the FixedCapacityVec isn’t full, it is returned as the Err

type Error = FixedCapacityVec<T, N>

The type returned in the event of a conversion error.

fn try_from( fcvec: FixedCapacityVec<T, N> ) -> Result<Box<[T; N]>, FixedCapacityVec<T, N>>

Performs the conversion.

impl<T: RefUnwindSafe, const N: usize> RefUnwindSafe for FixedCapacityVec<T, N>

impl<T: Send, const N: usize> Send for FixedCapacityVec<T, N>

impl<T: Sync, const N: usize> Sync for FixedCapacityVec<T, N>

impl<T: UnwindSafe, const N: usize> UnwindSafe for FixedCapacityVec<T, N>