Struct DynamicVec 

pub struct DynamicVec<T, const STACK_SIZE: usize> { /* private fields */ }

A dynamic vector that can store elements on both the stack and the heap.

The DynamicVec struct provides a flexible vector implementation that can store elements on the stack using the heapless::Vec type and on the heap using the Vec type. It allows for efficient storage of small vectors on the stack while automatically falling back to the heap for larger vectors.

Examples

Creating a new DynamicVec:

use sans_io_runtime::collections::DynamicVec;

let mut vec: DynamicVec<u32, 10> = DynamicVec::default();

Pushing elements into the DynamicVec:

use sans_io_runtime::collections::DynamicVec;

let mut vec: DynamicVec<u32, 10> = DynamicVec::default();
vec.push(1);
vec.push(2);
vec.push_stack(3).unwrap();

Accessing elements in the DynamicVec:

use sans_io_runtime::collections::DynamicVec;

let mut vec: DynamicVec<u32, 10> = DynamicVec::default();
vec.push(1);
vec.push(2);
vec.push_stack(3).unwrap();

assert_eq!(vec.get(0), Some(&1));
assert_eq!(vec.get(1), Some(&2));
assert_eq!(vec.get(2), Some(&3));

Implementations

impl<T, const STACK_SIZE: usize> DynamicVec<T, STACK_SIZE>

pub fn from<const SIZE: usize>(prepare: [T; SIZE]) -> Self

Creates a new instance of DynamicVec from an array of elements.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

pub fn iter(&self) -> impl Iterator<Item = &T>

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

Get the element at the given index.

pub fn set(&mut self, index: usize, value: T)

Set the element at the given index.

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

Get the mutable element at the given index.

pub fn get_mut_or_panic(&mut self, index: usize) -> &mut T

Get the mutable element at the given index or panic if not exists.

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

Push an element to the stack of the vector.

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

Push an element to the stack or the heap of the vector.

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

Pops the element from the end of the vector.

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

pub fn is_empty(&self) -> bool

Check if the vector is empty.

pub fn len(&self) -> usize

Returns the number of elements in the vector.

Trait Implementations

impl<T: Debug, const STACK_SIZE: usize> Debug for DynamicVec<T, STACK_SIZE>

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

Formats the value using the given formatter.

impl<T, const STACK_SIZE: usize> Default for DynamicVec<T, STACK_SIZE>

fn default() -> Self

Returns the “default value” for a type.