Struct StackVec

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

A stack-allocated vector with compile-time capacity N.

This type provides Vec-like functionality without heap allocation, making it suitable for use in audio processing hot paths where allocation latency is unacceptable.

Examples

use bbx_core::StackVec;

let mut vec: StackVec<i32, 4> = StackVec::new();
vec.push(1).unwrap();
vec.push(2).unwrap();

assert_eq!(vec.len(), 2);
assert_eq!(vec[0], 1);

Implementations

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

pub const fn new() -> StackVec<T, N>

Creates a new empty StackVec.

This is a const fn and can be used in const contexts.

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

Pushes a value onto the end of the vector.

Returns Ok(()) if successful, or Err(value) if the vector is full.

pub fn push_unchecked(&mut self, value: T)

Pushes a value onto the end of the vector without bounds checking.

Panics

Panics in debug mode if the vector is full. In release mode, this will not panic but the behavior is safe due to the debug assertion.

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

Removes and returns the last element, or None if empty.

pub const fn len(&self) -> usize

Returns the number of elements in the vector.

pub const fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

pub const fn is_full(&self) -> bool

Returns true if the vector is at capacity.

pub const fn capacity(&self) -> usize

Returns the maximum capacity of the vector.

pub fn clear(&mut self)

Removes all elements from the vector.

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

Returns a slice of the initialized elements.

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

Returns a mutable slice of the initialized elements.

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

Returns a reference to the element at the given index, or None if out of bounds.

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

Returns a mutable reference to the element at the given index, or None if out of bounds.

Trait Implementations

impl<T, const N: usize> Clone for StackVec<T, N>

where T: Clone,

fn clone(&self) -> StackVec<T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, const N: usize> Debug for StackVec<T, N>

where T: Debug,

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

Formats the value using the given formatter.

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

fn default() -> StackVec<T, N>

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<T, const N: usize> Index<usize> for StackVec<T, N>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &<StackVec<T, N> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<T, const N: usize> IndexMut<usize> for StackVec<T, N>

fn index_mut( &mut self, index: usize, ) -> &mut <StackVec<T, N> as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T, const N: usize> IntoIterator for &'a StackVec<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) -> <&'a StackVec<T, N> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> IntoIterator for &'a mut StackVec<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) -> <&'a mut StackVec<T, N> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T, const N: usize> IntoIterator for StackVec<T, N>

type Item = T

The type of the elements being iterated over.

type IntoIter = StackVecIntoIter<T, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <StackVec<T, N> as IntoIterator>::IntoIter

Creates an iterator from a value.