Struct HandleAllocator 

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

An allocator for generational handles.

Manages allocation and deallocation of handles, ensuring that stale handles are detected.

Implementations

impl<T> HandleAllocator<T>

pub fn new() -> Self

Creates a new empty allocator.

pub fn with_capacity(capacity: usize) -> Self

Creates an allocator with pre-allocated capacity.

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

Allocates a handle for the given value.

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

Deallocates a handle, returning the value if the handle was valid.

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

Gets a reference to the value, if the handle is valid.

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

Gets a mutable reference to the value, if the handle is valid.

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

Checks if a handle is valid.

pub fn len(&self) -> usize

Returns the number of allocated handles.

pub fn is_empty(&self) -> bool

Returns true if no handles are allocated.

pub fn capacity(&self) -> usize

Returns the total capacity.

pub fn clear(&mut self)

Clears all entries, deallocating all handles.

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

Iterates over all valid (handle, value) pairs.

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

Iterates over all valid (handle, value) pairs mutably.

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

Returns an iterator over all valid values (without handles).

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

Returns a mutable iterator over all valid values (without handles).

impl<T: Send + Sync> HandleAllocator<T>

pub fn par_values(&self) -> impl ParallelIterator<Item = &T>

Returns a parallel iterator over all valid values.

This uses rayon for work-stealing parallelism.

Example

use rayon::prelude::*;

allocator.par_values().for_each(|value| {
    // Process value in parallel
});

pub fn par_values_mut(&mut self) -> impl ParallelIterator<Item = &mut T>

Returns a parallel mutable iterator over all valid values.

Trait Implementations

impl<T: Debug> Debug for HandleAllocator<T>

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

Formats the value using the given formatter.

impl<T> Default for HandleAllocator<T>

fn default() -> Self

Returns the “default value” for a type.