Skip to main content

IdGenerator

Struct IdGenerator 

Source
pub struct IdGenerator<T> { /* private fields */ }
Expand description

Thread-safe ID allocator.

The counter starts at 1 so every allocated ID is a valid NonZeroU32. Zero is never handed out: it is the niche value that makes Option<Id> free (4 bytes, not 8). Allocation panics only after exhausting the full u32 space (>4 billion ids), which is treated as a programmer limit.

The counter uses Relaxed ordering: uniqueness needs the atomicity of the read-modify-write, not an ordering edge to any other memory location.

Implementations§

Source§

impl<T> IdGenerator<T>

Source

pub fn new() -> Self

Source

pub fn with_start(start: u32) -> Self

Source

pub fn next(&self) -> T
where T: From<NonZeroU32>,

Source

pub fn reserve(&self, count: u32) -> u32

Reserve count contiguous identifiers and return the first slot.

A caller that numbers a whole unit of work reserves one block, so the block order follows the caller’s order and never the thread timing. An empty reservation returns the next slot without consuming it.

Trait Implementations§

Source§

impl<T: Debug> Debug for IdGenerator<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for IdGenerator<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for IdGenerator<T>

§

impl<T> RefUnwindSafe for IdGenerator<T>

§

impl<T> Send for IdGenerator<T>
where PhantomData<T>: Send,

§

impl<T> Sync for IdGenerator<T>
where PhantomData<T>: Sync,

§

impl<T> Unpin for IdGenerator<T>
where PhantomData<T>: Unpin,

§

impl<T> UnsafeUnpin for IdGenerator<T>

§

impl<T> UnwindSafe for IdGenerator<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more