Struct IdPool

pub struct IdPool { /* private fields */ }

A pool for efficient allocation and reuse of u32 identifiers.

Freed IDs are stored in a min-heap, and reused such that the lowest available IDs are allocated first.

Implementations

impl IdPool

pub const fn new() -> Self

Creates a new empty IdPool.

pub fn with_capacity(capacity: usize) -> Self

Creates a new IdPool with the given initial capacity.

This is useful for preallocating space for IDs to avoid reallocations.

pub fn alloc(&mut self) -> u32

Allocates a new ID.

If there are free IDs available, the lowest free ID is reused.

pub fn free(&mut self, id: u32)

Frees an ID, making it available for reuse.

The ID is assumed to not already be freed.

pub fn clear(&mut self)

Clears the pool, removing all free IDs and resetting the next index.

pub fn len(&self) -> usize

Returns the number of allocated IDs.

pub fn free_len(&self) -> usize

Returns the number of free IDs.

pub fn total_len(&self) -> usize

Returns the total number of IDs (allocated + free).

pub fn is_empty(&self) -> bool

Returns true if the pool is empty (no allocated IDs).

Trait Implementations

impl Clone for IdPool

fn clone(&self) -> IdPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdPool

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

Formats the value using the given formatter.

impl Default for IdPool

fn default() -> IdPool

Returns the “default value” for a type.