Struct UniqueIdAllocator

pub struct UniqueIdAllocator<T: IntegerIdCounter> { /* private fields */ }

Allocates unique integer ids.

Guarantees that each call to the Self::alloc function will return a unique id, unless Self::reset is called.

Ids start at IntegerIdCounter::START by default, counting upwards from there.

Implementations

impl<T: IntegerIdCounter> UniqueIdAllocator<T>

pub fn max_used_id(&self) -> Option<T>

Return the maximum currently used id, or None if no ids have been allocated yet.

pub const fn new() -> Self

Create a new allocator, using T::START as the first id (usually zero).

pub const fn with_start(start: T) -> Self

Create a new allocator, using the specified value as the first id.

pub fn alloc(&self) -> T

Attempt to allocate a new id, panicking if none are available.

See Self::try_alloc for a version that returns an error

pub fn try_alloc(&self) -> Result<T, IdExhaustedError<T>>

Attempt to allocate a new id, returning an error if there are no more available.

pub fn reset(&mut self)

Reset the allocator to a pristine state, beginning allocations all over again.

Trait Implementations

impl<T: Clone + IntegerIdCounter> Clone for UniqueIdAllocator<T>

fn clone(&self) -> UniqueIdAllocator<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + IntegerIdCounter> Debug for UniqueIdAllocator<T>

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

Formats the value using the given formatter.

impl<T: IntegerIdCounter> Default for UniqueIdAllocator<T>

fn default() -> Self

Returns the “default value” for a type.