Struct storagevec::svec::StorageVec

#[repr(transparent)]pub struct StorageVec<T: Default, const N: usize>(_);

A list-like object that will either use the tinyvec ArrayVec, the standard library Vec, or the tinyvec TinyVec as a backing implementation. It will use the alloc and stack features to control this.

Implementations

impl<T: Default, const N: usize> StorageVec<T, N>

#[must_use]pub fn new() -> Self

Create a new StorageVec.

pub fn try_push(&mut self, item: T) -> Result<(), T>

Try to push an item onto this list.

Errors

If the push operation fails due to capacity overflow, the element is returned back in an Err.

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

Push an item onto this list, and panic if the push operation failed.

pub fn pop(&mut self) -> Option<T>

Pop an item from the back of this list.

pub fn try_insert(&mut self, item: T, index: usize) -> Result<(), T>

Try to insert an item into this list.

Errors

If the element cannot be inserted into the list due to capacity overflow, the element is returned back in an Err.

pub fn insert(&mut self, item: T, index: usize)

Insert an item into this list, and panic if the insert operation fails.

pub fn remove(&mut self, index: usize) -> Option<T>

Remove an item from this list.

pub fn drain<'a, R: RangeBounds<usize> + 'a>(
    &'a mut self,
    range: R
) -> impl Iterator<Item = T> + 'a where
    T: 'a, 

Create a drain iterator for this vector.

Trait Implementations

impl<T: Clone + Default, const N: usize> Clone for StorageVec<T, N>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default + Debug, const N: usize> Debug for StorageVec<T, N>

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

Formats the value using the given formatter.

impl<T: Default, const N: usize> Default for StorageVec<T, N>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: Default, const N: usize> Deref for StorageVec<T, N>

type Target = [T]

The resulting type after dereferencing.

pub fn deref(&self) -> &[T]

Dereferences the value.

impl<T: Default, const N: usize> DerefMut for StorageVec<T, N>

pub fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.

impl<T: Default, const N: usize> Extend<T> for StorageVec<T, N>

pub fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: Default, const N: usize> FromIterator<T> for StorageVec<T, N>

pub fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Default, const N: usize> IntoIterator for StorageVec<T, N>

type Item = T

The type of the elements being iterated over.

type IntoIter = StorageVecIterator<T, N>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.