Struct Canonical 

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

Type-safe envelope for immutable, canonical data.

Implementations

impl<T> Canonical<T>

where T: IsCanonical + Debug,

pub fn tie(canonical: T) -> Self

Enclose the argument into an immutable Canonical envelope.

The caller is responsible to ensure that the argument is considered as canonical, e.g. by invoking Canonicalize::canonicalize() beforehand if needed. A debug assertion verifies at runtime that the given argument is canonical.

pub const fn tie_unchecked(canonical: T) -> Self

Enclose the argument into an immutable Canonical envelope.

const fn version of Canonical::tie() without a debug assertion. Use deliberately!

pub fn untie(self) -> T

Release the enclosed type from the Canonical envelope.

impl<T> Canonical<T>

where T: IsCanonical,

pub fn as_canonical_ref(&self) -> Canonical<&T>

impl<T> Canonical<Vec<T>>

where T: IsCanonical,

pub fn as_canonical_slice(&self) -> Canonical<&[T]>

impl Canonical<String>

pub fn as_canonical_str(&self) -> Canonical<&str>

Trait Implementations

impl<T> AsRef<T> for Canonical<T>

fn as_ref(&self) -> &T

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

impl<T: Clone> Clone for Canonical<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Canonical<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Canonical<T>

fn default() -> Canonical<T>

Returns the “default value” for a type.

impl<T> Deref for Canonical<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Hash> Hash for Canonical<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> IsCanonical for Canonical<T>

where T: IsCanonical,

fn is_canonical(&self) -> bool

Check if the representation of self is canonical.

impl<T: Ord> Ord for Canonical<T>

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

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

fn partial_cmp(&self, other: &Canonical<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: Copy> Copy for Canonical<T>

impl<T: Eq> Eq for Canonical<T>

impl<T> StructuralPartialEq for Canonical<T>