Struct Persist

pub struct Persist<T> { /* private fields */ }

Iteration will not always be in order

Implementations

impl<T> Persist<T>

pub fn with_capacity(capacity: usize) -> Persist<T>

Allocate with capacity.

This is the only way to create a new persistent vec.

Panics

Will panic if the selected capacity is larger than the ability for Persist to internally index in to

pub fn with_capacity_filled_by<F>(capacity: usize, func: F) -> Persist<T>

where F: Fn() -> T,

Allocate with capacity and fill with values produced by a closure

This is a secondary way to create a new persistent vec and is a good way to do so if you know the storage needs to be filled.

Panics

Will panic if the selected capacity is larger than the ability for Persist to internally index in to

pub fn from(slice: &[T]) -> Persist<T>

where T: Clone,

pub fn len(&self) -> usize

Returns the actual used length regardless of capacity

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> usize

Returns the storage capacity

pub fn clear(&mut self)

Clear the storage out while keeping allocated memory

Should not ever panic

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

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

pub fn is_index_live(&self, index: usize) -> bool

Check if there is a value at this index

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

Push T on to storage.

A push is not guaranteed to push in any particular order if the internal storage has empty locations (typical after many remove). For this reason it will return the index pushed to.

Returns None if there are no free slots left

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

Insert T at location. Returns existing value in that location or None.

Panics

Will panic is the index is out of range

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

Pop the last value in the Persist

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

Remove the item at this index and return it if it exists. Does not shift elements after it to the left.

pub fn iter(&self) -> Iter<'_, T>

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Trait Implementations

impl<T: Debug> Debug for Persist<T>

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

Formats the value using the given formatter.

impl<T: Clone> From<&[T]> for Persist<T>

Total capacity will be set from the length of the slice

fn from(s: &[T]) -> Persist<T>

Converts to this type from the input type.

impl<T: Clone> From<&mut [T]> for Persist<T>

Total capacity will be set from the length of the slice

fn from(s: &mut [T]) -> Persist<T>

Converts to this type from the input type.