Struct Cmp

#[repr(transparent)]
pub struct Cmp<T: ?Sized = dyn Display>(pub T);

A wrapper type that compares the inner value in its Display representation.

This implements Eq, Ord and Hash traits with eq, cmp and hash functions.

Example

Wrapping !FmtOrd types:

assert_eq!(fmt_cmp::Cmp(f64::NAN), fmt_cmp::Cmp(f64::NAN));
assert!(fmt_cmp::Cmp(42) > fmt_cmp::Cmp(240));

Sorting integers lexicographically:

use std::collections::BTreeSet;

let mut values: BTreeSet<fmt_cmp::Cmp<u32>> = (1..=10).map(fmt_cmp::Cmp).collect();
assert!(values
  .into_iter()
  .map(|cmp| cmp.0)
  .eq([1, 10, 2, 3, 4, 5, 6, 7, 8, 9]));

Tuple Fields

0: T

Implementations

impl<T: Display + ?Sized> Cmp<T>

pub fn from_ref(value: &T) -> &Self

Wraps a reference of type T as a reference of Cmp<T>.

pub fn from_boxed(boxed: Box<T>) -> Box<Self>

Converts a Box<T> into Box<Cmp<T>>.

pub fn into_boxed_inner(self: Box<Self>) -> Box<T>

Converts a Box<Cmp<T>> into a Box<T>.

Trait Implementations

impl<T> AsRef<T> for Cmp<T>

fn as_ref(&self) -> &T

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

impl<T: Clone + ?Sized> Clone for Cmp<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for Cmp<T>

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

Formats the value using the given formatter.

impl<T: Default + Display> Default for Cmp<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display + ?Sized> Display for Cmp<T>

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

Formats the value using the given formatter.

impl<'a, T: Display + ?Sized> From<&'a T> for &'a Cmp<T>

fn from(t: &T) -> &Cmp<T>

Converts to this type from the input type.

impl<T: Display + ?Sized> From<Box<T>> for Box<Cmp<T>>

fn from(boxed: Box<T>) -> Self

Converts to this type from the input type.

impl<T: Display + ?Sized> Hash for Cmp<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: Display + ?Sized> Ord for Cmp<T>

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.

impl<T: Display + ?Sized, U: Display + ?Sized> PartialEq<Cmp<U>> for Cmp<T>

fn eq(&self, other: &Cmp<U>) -> 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: Display + ?Sized, U: Display + ?Sized> PartialOrd<Cmp<U>> for Cmp<T>

fn partial_cmp(&self, other: &Cmp<U>) -> 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 + ?Sized> Copy for Cmp<T>

impl<T: Display + ?Sized> Eq for Cmp<T>

impl<T: Display + ?Sized> FmtEq for Cmp<T>

impl<T: Display + ?Sized> FmtOrd for Cmp<T>