Struct Invariant

pub struct Invariant<T>(/* private fields */);

A marker for forcing T to be considered invariant.

Implementations

impl<T> Invariant<T>

pub fn new() -> Self

Create a new Invariant marker instance.

All instances of Invariant with the same T are equivalent.

Trait Implementations

impl<T> Clone for Invariant<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Invariant<T>

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

Formats the value using the given formatter.

impl<T> Default for Invariant<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Hash for Invariant<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> Ord for Invariant<T>

fn cmp(&self, _: &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<T> PartialEq for Invariant<T>

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

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

fn ne(&self, _: &Self) -> bool

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

impl<T> PartialOrd for Invariant<T>

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

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

fn lt(&self, _: &Self) -> bool

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

fn le(&self, _: &Self) -> bool

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

fn gt(&self, _: &Self) -> bool

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

fn ge(&self, _: &Self) -> bool

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

impl<T> Copy for Invariant<T>

impl<T> Eq for Invariant<T>

impl<T> Send for Invariant<T>

impl<T> Sync for Invariant<T>