Struct ExampleIdSeqUsize

Source
pub struct ExampleIdSeqUsize { /* private fields */ }
Available on doc or test only.
Expand description

A unique sequential identifier usize generator.

The counter starts at usize::MIN + 1, and increments with each new identifier generated.

The implementation guards against wrap-around after usize::MAX, by returning None in the checked methods, or panicking in the unchecked methods.

See also the id_seq macro.

Implementations§

Source§

impl ExampleIdSeqUsize

Source

pub fn new() -> Option<Self>

Generates some unique ExampleIdSeqUsize ID.

Alias of new_balanced.

Returns None on overflow.

Source

pub fn new_unchecked() -> Self

Generates some unique ExampleIdSeqUsize ID.

Alias of new_balanced_unchecked.

§Panics

Panics on overflow.

Source

pub fn new_strong() -> Option<Self>

Generates some unique ExampleIdSeqUsize ID with SeqCst ordering.

Ensures the strongest memory consistency across all threads, even at the cost of performance.

Returns None on overflow.

Source

pub fn new_strong_unchecked() -> Self

Generates a unique ExampleIdSeqUsize ID with SeqCst ordering.

Ensures the strongest memory consistency across all threads, even at the cost of performance.

§Panics

Panics on overflow.

Source

pub fn new_balanced() -> Option<Self>

Generates some unique ExampleIdSeqUsize ID with AcqRel ordering.

Balances performance and memory safety, ensuring consistent visibility across threads.

Returns None on overflow.

Source

pub fn new_balanced_unchecked() -> Self

Generates a unique ExampleIdSeqUsize ID with AcqRel ordering.

Balances performance and memory safety, ensuring consistent visibility across threads.

§Panics

Panics on overflow.

Source

pub fn new_fast() -> Option<Self>

Generates some unique ExampleIdSeqUsize ID with Relaxed ordering.

Offers maximum performance in low-contention scenarios where memory ordering is not a concern.

Returns None on overflow.

Source

pub fn new_fast_unchecked() -> Self

Generates a unique ExampleIdSeqUsize ID with Relaxed ordering.

Offers maximum performance in low-contention scenarios where memory ordering is not a concern.

§Panics

Panics on overflow.

Source

pub fn iter_strong() -> impl Iterator<Item = ExampleIdSeqUsize>

Iterator over generated IDs with SeqCst ordering.

Ensures the strongest memory consistency across all threads, even at the cost of performance.

Source

pub fn iter_strong_unchecked() -> impl Iterator<Item = ExampleIdSeqUsize>

Iterator over generated IDs with SeqCst ordering.

Ensures the strongest memory consistency across all threads, even at the cost of performance.

§Panics

Panics on overflow.

Source

pub fn iter_balanced() -> impl Iterator<Item = ExampleIdSeqUsize>

Iterator over generated IDs with AcqRel ordering.

Balances performance and memory safety, ensuring consistent visibility across threads.

Source

pub fn iter_balanced_unchecked() -> impl Iterator<Item = ExampleIdSeqUsize>

Iterator over generated IDs with AcqRel ordering.

Balances performance and memory safety, ensuring consistent visibility across threads.

§Panics

Panics on overflow.

Source

pub fn iter_fast() -> impl Iterator<Item = ExampleIdSeqUsize>

Iterator over generated IDs with Relaxed ordering.

Offers maximum performance in low-contention scenarios where memory ordering is not a concern.

Source

pub fn iter_fast_unchecked() -> impl Iterator<Item = ExampleIdSeqUsize>

Iterator over generated IDs with Relaxed ordering.

Offers maximum performance in low-contention scenarios where memory ordering is not a concern.

§Panics

Panics on overflow.

Source

pub fn value(&self) -> usize

Returns the underlying unique ID value as a usize.

The value is guaranteed to be a valid sequential identifier, from usize::MIN to usize::MAX.

Source

pub fn generated_ids() -> usize

Returns the number of IDs generated so far.

Alias of generated_ids_balanced.

Source

pub fn generated_ids_strong() -> usize

Returns the number of IDs generated so far with SeqCst ordering.

Ensures the strongest memory consistency across all threads, even at the cost of performance.

Source

pub fn generated_ids_balanced() -> usize

Returns the number of IDs generated so far with Acquire ordering.

Balances performance and memory safety, ensuring consistent visibility across threads.

Source

pub fn generated_ids_fast() -> usize

Returns the number of IDs generated so far with Relaxed ordering.

Offers maximum performance in low-contention scenarios where memory ordering is not a concern.

Source

pub fn remaining_ids() -> usize

Returns the number of remaining IDs.

Alias of remaining_ids_balanced.

Source

pub fn remaining_ids_strong() -> usize

Returns the number of remaining IDs with SeqCst ordering.

Ensures the strongest memory consistency across all threads, even at the cost of performance.

Source

pub fn remaining_ids_balanced() -> usize

Returns the number of remaining IDs with Acquire ordering.

Balances performance and memory safety, ensuring consistent visibility across threads.

Source

pub fn remaining_ids_fast() -> usize

Returns the number of remaining IDs with Relaxed ordering.

Offers maximum performance in low-contention scenarios where memory ordering is not a concern.

Trait Implementations§

Source§

impl Debug for ExampleIdSeqUsize

Source§

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

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

impl From<ExampleIdSeqUsize> for usize

Source§

fn from(from: ExampleIdSeqUsize) -> usize

Converts to this type from the input type.
Source§

impl Hash for ExampleIdSeqUsize

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ExampleIdSeqUsize

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ExampleIdSeqUsize

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for ExampleIdSeqUsize

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Eq for ExampleIdSeqUsize

Auto Trait Implementations§

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> ByteSized for T

Source§

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Source§

const BYTE_SIZE: usize = _

The size of this type in bytes.
Source§

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.
Source§

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more
Source§

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
Source§

impl<T, R> Chain<R> for T
where T: ?Sized,

Source§

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.
Source§

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.
Source§

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

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

Source§

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Source§

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Source§

fn type_name(&self) -> &'static str

Returns the type name of self. Read more
Source§

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Source§

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.
Source§

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.
Source§

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Source§

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more
Source§

fn downcast_ref<T: 'static>(&self) -> Option<&T>

Available on crate feature unsafe_layout only.
Returns some shared reference to the inner value if it is of type T. Read more
Source§

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T>

Available on crate feature unsafe_layout only.
Returns some exclusive reference to the inner value if it is of type T. Read more
Source§

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

Source§

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Source§

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more
Source§

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more
Source§

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more
Source§

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more
Source§

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Source§

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Source§

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Source§

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Source§

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Source§

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Source§

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Source§

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

fn mem_as_bytes(&self) -> &[u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Source§

fn mem_as_bytes_mut(&mut self) -> &mut [u8]
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

Source§

impl<T> Hook for T

Source§

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more
Source§

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more
§

impl<T> Instrument for T

§

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

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

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
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Ungil for T
where T: Send,