Struct IdFactory

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

A helper for constructing id types like FunctionId.

For ids that may be re-used, see IdFactoryWithReuse.

Implementations

impl<T> IdFactory<T>

pub fn new(start: T, max: T) -> Self

where T: Into<NonZeroU64> + Ord,

Create a factory for ids in the range start..=max.

pub const fn new_const(start: NonZeroU64, max: NonZeroU64) -> Self

Create a factory for ids in the range start..=max.

Provides a less convenient API than IdFactory::new, but skips a type conversion that would make the function non-const.

impl<T> IdFactory<T>

where T: TryFrom<NonZeroU64>,

pub fn get(&self) -> T

Return a unique new id.

Panics if the id type overflows.

pub fn wrapping_get(&self) -> T

Returns an id, potentially allowing an overflow. This may cause ids to be silently re-used. Used for crate::id::ExecutionId.

If id re-use is desired only for “freed” ids, use IdFactoryWithReuse instead.