Struct GenerationalBuffer

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

A generic append-only circular buffer with generational IDs

Inserting returns a Handle that can be used to access the value later, checking the item hasn’t been replaced in the meantime.

Items can’t be individually removed, but the entire buffer can be cleared, which invalidates all existing handles.

Implementations

impl<T> GenerationalBuffer<T>

pub fn new(max_capacity: usize) -> Self

Creates a new generational buffer with the specified capacity

pub fn capacity(&self) -> usize

Returns the maximum capacity of the buffer

pub fn len(&self) -> usize

Returns the current number of entries in the buffer

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty

pub fn clear(&mut self)

Clear the buffer, removing all entries and rendering all existing handles invalid.

pub fn is_full(&self) -> bool

Returns true if the buffer has reached its maximum capacity

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

Inserts a value into the buffer and returns a handle to it.

This removes the oldest entry if the buffer is full.

pub fn get(&self, handle: Handle<T>) -> Option<&T>

Gets a reference to the value associated with the handle

pub fn get_mut(&mut self, handle: Handle<T>) -> Option<&mut T>

Gets a mutable reference to the value associated with the handle

pub fn is_valid(&self, handle: Handle<T>) -> bool

Checks if a handle is still valid (points to existing data)

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

Returns an iterator over all entries with their handles, in no particular order

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

Returns an iterator over all entries, in no particular order

pub fn handles(&self) -> impl Iterator<Item = Handle<T>> + '_

Returns an iterator over all valid handles, in no particular order

Trait Implementations

impl<T: Debug> Debug for GenerationalBuffer<T>

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

Formats the value using the given formatter.