Struct Id

#[repr(transparent)]
pub struct Id<T = usize>(pub T);

Id is a generic identifier type that wraps a value of type T.

Tuple Fields

0: T

Implementations

impl<T> Id<T>

pub const fn new(id: T) -> Self

create a new identifier from the given value

pub fn default() -> Self

where T: Default,

Create a new identifier with the default value

pub fn one() -> Self

where T: One,

returns a new id with a value of 1

pub fn zero() -> Self

where T: Zero,

returns a new id with a value of 0

pub fn random() -> Self

where StandardUniform: Distribution<T>,

pub const fn get(&self) -> &T

returns an immutable reference to the inner value

pub const fn get_mut(&mut self) -> &mut T

returns a mutable reference to the inner value

pub fn value(self) -> T

consumes the current instance to return the inner value

pub const fn replace(&mut self, id: T) -> T

use the replace method to update and return the inner value

pub fn set(&mut self, id: T) -> &mut Self

mutate the inner value and return a mutable reference to the wrapper for chaining

pub const fn swap(&mut self, id: &mut Id<T>)

swap the inner value with that of another identifier instance of the same type T

pub fn take(&mut self) -> T

where T: Default,

take the inner value, leaving the logical default value in its place.

pub fn with<U>(self, id: U) -> Id<U>

consumes the current instance to replace it with another.

pub fn map<U, F>(self, f: F) -> Id<U>

where F: FnOnce(T) -> U,

apply a function onto the inner value and return a new instance with the result

pub fn step(&mut self) -> T

where T: One, for<'a> &'a T: Add<T, Output = T>,

replaces the current id with the next logical value of type T

use scsys::Id;

let mut id = Id::zero();
assert_eq!(id.step(), 0);
assert_eq!(id.step(), 1);

pub const fn view(&self) -> Id<&T>

returns a new identifier with a reference to the inner value

pub const fn view_mut(&mut self) -> Id<&mut T>

returns a new identifier with a mutable reference to the inner value

impl Id<usize>

pub fn atomic() -> Self

pub fn atomic_step(&mut self) -> usize

replaces the current id with the atomic-ally next value and returns the previous value. see step for more information

impl<T> Id<&T>

pub fn cloned(&self) -> Id<T>

where T: Clone,

returns a new identifier with a cloned inner value

pub fn copied(&self) -> Id<T>

where T: Copy,

returns a new identifier with the inner value copied

impl<T> Id<&mut T>

pub fn cloned(&self) -> Id<T>

where T: Clone,

returns a new identifier with a cloned inner value

pub fn copied(&self) -> Id<T>

where T: Copy,

returns a new identifier with the inner value copied

Trait Implementations

impl<T> AsMut<T> for Id<T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for Id<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Binary for Id<T>

where T: Binary,

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

Formats the value using the given formatter.

impl<T> Borrow<T> for Id<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for Id<T>

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

Mutably borrows from an owned value.

impl<T: Clone> Clone for Id<T>

fn clone(&self) -> Id<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Id<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Id<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Id<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Id<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for Id<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Id<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Id<T>

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<T> LowerExp for Id<T>

where T: LowerExp,

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

Formats the value using the given formatter.

impl<T> LowerHex for Id<T>

where T: LowerHex,

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

Formats the value using the given formatter.

impl<T> Octal for Id<T>

where T: Octal,

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

Formats the value using the given formatter.

impl<T: Ord> Ord for Id<T>

fn cmp(&self, other: &Id<T>) -> 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<'a, Q> PartialEq<&'a Q> for Id<Q>

where Q: PartialEq,

fn eq(&self, other: &&'a Q) -> 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<'a, Q> PartialEq<&'a mut Q> for Id<Q>

where Q: PartialEq,

fn eq(&self, other: &&'a mut Q) -> 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<Q> PartialEq<Q> for Id<Q>

where Q: PartialEq,

fn eq(&self, other: &Q) -> 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<T: PartialEq> PartialEq for Id<T>

fn eq(&self, other: &Id<T>) -> 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<Q> PartialOrd<Q> for Id<Q>

where Q: PartialOrd,

fn partial_cmp(&self, other: &Q) -> 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<T: PartialOrd> PartialOrd for Id<T>

fn partial_cmp(&self, other: &Id<T>) -> 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<T> Pointer for Id<T>

where T: Pointer,

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

Formats the value using the given formatter.

impl<T> Serialize for Id<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> UpperExp for Id<T>

where T: UpperExp,

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

Formats the value using the given formatter.

impl<T> UpperHex for Id<T>

where T: UpperHex,

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Id<T>

impl<T: Eq> Eq for Id<T>

impl<T> Identifier for Id<T>

impl<T> StructuralPartialEq for Id<T>