Struct Factory

pub struct Factory<T: Aictable> { /* private fields */ }

A factory for generating unique IDs of a specific type.

Implementations

impl<T: Aictable> Factory<T>

pub fn new(initial_value: T, looping: bool, rewind: bool) -> Self

Creates a new Factory with the specified initial value, looping behavior, and rewind behavior.

It’s recommended to use a FactoryBuilder to build a Factory. See the document of FactoryBuilder for details.

pub fn builder() -> FactoryBuilder<T>

Returns a new FactoryBuilder.

pub fn next(&mut self) -> Result<T, Error<T>>

Generates and returns the next unique ID.

Errors

• If no more IDs can be generated, it returns an Error::OutOfSpace.
• If Factory::looping is false and the current ID is already the maximum value of the type, it returns an Error::MaxReached.

pub fn remove(&mut self, id: T) -> bool

Removes the specified ID from the set of generated IDs, so that it can be reused.

Returns whether the ID was present in the set.

pub fn reset(&mut self)

Resets the factory to its initial state.

pub fn take_up(&mut self, id: T) -> Result<(), Error<T>>

Manually marks the specified ID as used.

Errors

• If the ID is already taken, it returns an Error::AlreadyExist<T>.