Struct array_vec::ArrayVec

pub struct ArrayVec<T, const N: usize> { /* fields omitted */ }

An array backed fixed capcity vector

Methods

impl<T: Clone, const N: usize> ArrayVec<T, { N }>

pub fn extend_from_slice(&mut self, slice: &[T])

impl<T, const N: usize> ArrayVec<T, { N }>

pub fn as_ptr(&self) -> *const T

The pointer to the start of the array, only valid to read for self.len() elements

This pointer is not valid to write to, use as_mut_ptr instead

pub fn as_mut_ptr(&mut self) -> *mut T

The pointer to the start of the array, only valid to read for self.len() elements, and to write for N elements

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

As a shared reference to a slice

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

As a unique reference to a slice

pub fn push(&mut self, value: T) -> Result<(), T>

Puts an element onto the end of the ArrayVec

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

Insert a single element into the ArrayVec at the given index

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

Removes the last element from the ArrayVec

pub fn push_array<const M: usize>(
    &mut self,
    array: [T; M]
) -> Result<(), [T; M]>

Put all of the elements of the array into the end of the ArrayVec

pub fn insert_array<const M: usize>(
    &mut self,
    arr: [T; M],
    index: usize
) -> Result<(), [T; M]>

Insert all of the elements of the array into the ArrayVec at the given index

pub fn pop_array<const M: usize>(&mut self) -> Option<[T; M]>

Pop the last M elements of the array at once

pub fn len(&self) -> usize

The length of the ArrayVec

pub fn clear(&mut self)

Removes all elements from the ArrayVec

pub fn into_array(self) -> [T; N]

Convert to an array, panics if the ArrayVec is not full

pub unsafe fn into_array_unchecked(self) -> [T; N]

Convert to an array, not checked in release mode and will panic in debug mode

Trait Implementations

impl<T, const N: usize> Extend<T> for ArrayVec<T, { N }>

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

Extends a collection with the contents of an iterator.

impl<T, const N: usize> Default for ArrayVec<T, { N }>

Creates a new empty array

fn default() -> Self

Returns the "default value" for a type.

impl<T, const N: usize> Drop for ArrayVec<T, { N }>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: PartialEq, const N: usize, const M: usize> PartialEq<ArrayVec<T, M>> for ArrayVec<T, { N }>

fn eq(&self, other: &ArrayVec<T, { M }>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Clone, const N: usize> Clone for ArrayVec<T, { N }>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialOrd, const N: usize, const M: usize> PartialOrd<ArrayVec<T, M>> for ArrayVec<T, { N }>

fn partial_cmp(&self, other: &ArrayVec<T, { M }>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Ord, const N: usize> Ord for ArrayVec<T, { N }>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T, const N: usize> From<[T; N]> for ArrayVec<T, { N }>

fn from(arr: [T; N]) -> Self

Performs the conversion.

impl<T, const N: usize> IntoIterator for ArrayVec<T, { N }>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T, { N }>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> IntoIterator for &'a mut ArrayVec<T, { N }>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> IntoIterator for &'a ArrayVec<T, { N }>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Eq, const N: usize> Eq for ArrayVec<T, { N }>

impl<T: Hash, const N: usize> Hash for ArrayVec<T, { N }>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T, const N: usize> Deref for ArrayVec<T, { N }>

type Target = [T]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, const N: usize> DerefMut for ArrayVec<T, { N }>

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

Mutably dereferences the value.

impl<T, const N: usize> FromIterator<T> for ArrayVec<T, { N }>

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

Creates a value from an iterator.

impl<T, const N: usize> TryInto<[T; N]> for ArrayVec<T, { N }>

type Error = Self

The type returned in the event of a conversion error.

fn try_into(self) -> Result<[T; N], Self>

Performs the conversion.