Struct ExampleIdSeqUsize

pub struct ExampleIdSeqUsize { /* private fields */ }

Available on doc or test only.

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

impl ExampleIdSeqUsize

pub fn new() -> Option<Self>

Generates some unique ExampleIdSeqUsize ID.

Alias of new_balanced.

Returns None on overflow.

pub fn new_unchecked() -> Self

Generates some unique ExampleIdSeqUsize ID.

Alias of new_balanced_unchecked.

Panics

Panics on overflow.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn generated_ids() -> usize

Returns the number of IDs generated so far.

Alias of generated_ids_balanced.

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.

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.

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.

pub fn remaining_ids() -> usize

Returns the number of remaining IDs.

Alias of remaining_ids_balanced.

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.

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.

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

impl Debug for ExampleIdSeqUsize

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

Formats the value using the given formatter.

impl From<ExampleIdSeqUsize> for usize

fn from(from: ExampleIdSeqUsize) -> usize

Converts to this type from the input type.

impl Hash for ExampleIdSeqUsize

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ExampleIdSeqUsize

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ExampleIdSeqUsize

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ExampleIdSeqUsize

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for ExampleIdSeqUsize