Struct Unique

pub struct Unique(/* private fields */);

This type represents a unique token.

Each call to Unique::new() returns a unique value. The only way to create a token that compares equal is to clone or copy an existing token.

Examples

use unique_token::Unique;

let x = Unique::new();
let y = Unique::new();

// clones are equal
assert_eq!(x, x.clone());
assert_eq!(y, y.clone());

// tokens from different calls are unequal
assert_ne!(x, y);

Implementation

Each token is provided with a unique ID by incrementing a static AtomicU64.

Implementations

impl Unique

pub fn new() -> Self

Create a new token.

All tokens created by this function compare unequal.

Panics

This function panics if u64::MAX unique tokens have been created. In practice, this should never happen; creating one token per nanosecond allows for a runtime of almost six centuries.

Trait Implementations

impl Clone for Unique

fn clone(&self) -> Unique

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Unique

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

Formats the value using the given formatter.

impl From<&Unique> for u64

fn from(token: &Unique) -> u64

Converts to this type from the input type.

impl Hash for Unique

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 PartialEq for Unique

fn eq(&self, other: &Unique) -> 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 Copy for Unique

impl Eq for Unique

impl StructuralPartialEq for Unique