Struct InvariantId 

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

A compiler-assigned stable invariant identifier.

Implementations

impl InvariantId

pub const fn new(value: u32) -> Option<Self>

Creates an identifier from its numeric representation.

pub const fn get(self) -> u32

Returns the numeric representation.

pub const fn to_be_bytes(self) -> [u8; 4]

Returns the canonical big-endian representation.

impl InvariantId

pub const fn first() -> Self

Returns the first value in this one-based allocation space.

pub const fn checked_next(self) -> Option<Self>

Returns the next value, or None when the allocation space is exhausted.

Trait Implementations

impl Clone for InvariantId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InvariantId

impl Debug for InvariantId

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

Formats the value using the given formatter.

impl Display for InvariantId

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

Formats the value using the given formatter.

impl Eq for InvariantId

impl From<InvariantId> for u32

fn from(value: InvariantId) -> Self

Converts to this type from the input type.

impl Hash for InvariantId

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 InvariantId

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for InvariantId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for InvariantId

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 StructuralPartialEq for InvariantId

impl TryFrom<u32> for InvariantId

type Error = ZeroNumericIdError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.