Struct coord::id_alloc::IdAllocator

pub struct IdAllocator(Mutex<IdAllocatorInner>);

Manages allocation of u32 IDs.

Note that the current implementation wastes memory. It would be far more efficient to use a compressed bitmap, like https://roaringbitmap.org or the hibitset crate, but neither presently supports a fast “find first zero” operation.

Tuple Fields

0: Mutex<IdAllocatorInner>

Implementations

impl IdAllocator

pub fn new(min: u32, max: u32) -> IdAllocator

Creates a new IdAllocator that will assign IDs between min and max, both inclusive.

pub fn alloc(&self) -> Result<u32, CoordError>

Allocates a new ID.

pub fn free(&self, id: u32)

Releases a new ID back to the pool.

It is undefined behavior to free an ID twice, or to free an ID that was not allocated by this allocator.

Trait Implementations

impl Debug for IdAllocator

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

Formats the value using the given formatter.