Trait typenum::type_operators::Cmp

[+] Show declaration

pub trait Cmp<Rhs = Self> {
    type Output;
}

[−] Expand description

A type operator for comparing Self and Rhs. It provides a similar functionality to the function core::cmp::Ord::cmp but for types.

Example

use typenum::{Cmp, Ord, N3, P2, P5};
use std::cmp::Ordering;

assert_eq!(<P2 as Cmp<N3>>::Output::to_ordering(), Ordering::Greater);
assert_eq!(<P2 as Cmp<P2>>::Output::to_ordering(), Ordering::Equal);
assert_eq!(<P2 as Cmp<P5>>::Output::to_ordering(), Ordering::Less);

Associated Types

type Output[−]

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

Implementors

impl Cmp<B0> for B0[+]

[+] Show hidden undocumented items

type Output = Equal

fn compare<P: InternalMarker>(&self, _: &B0) -> Self::Output

impl Cmp<B0> for B1[+]

[+] Show hidden undocumented items

type Output = Greater

fn compare<P: InternalMarker>(&self, _: &B0) -> Self::Output

impl Cmp<B1> for B0[+]

[+] Show hidden undocumented items

type Output = Less

fn compare<P: InternalMarker>(&self, _: &B1) -> Self::Output

impl Cmp<B1> for B1[+]

[+] Show hidden undocumented items

type Output = Equal

fn compare<P: InternalMarker>(&self, _: &B1) -> Self::Output

impl Cmp<Z0> for Z0[+]

0 == 0

[+] Show hidden undocumented items

type Output = Equal

fn compare<IM: InternalMarker>(&self, _: &Z0) -> Self::Output

impl Cmp<UTerm> for UTerm[+]

Zero == Zero

[+] Show hidden undocumented items

type Output = Equal

fn compare<IM: InternalMarker>(&self, _: &UTerm) -> Self::Output

impl<Nl: Unsigned + NonZero, Nr: Cmp<Nl> + Unsigned + NonZero> Cmp<NInt<Nr>> for NInt<Nl>[+]

-X <==> -Y

[+] Show hidden undocumented items

type Output = <Nr as Cmp<Nl>>::Output

fn compare<IM: InternalMarker>(&self, rhs: &NInt<Nr>) -> Self::Output

impl<P: Unsigned + NonZero, N: Unsigned + NonZero> Cmp<NInt<N>> for PInt<P>[+]

X > - Y

[+] Show hidden undocumented items

type Output = Greater

fn compare<IM: InternalMarker>(&self, _: &NInt<N>) -> Self::Output

impl<P: Unsigned + NonZero, N: Unsigned + NonZero> Cmp<PInt<P>> for NInt<N>[+]

-X < Y

[+] Show hidden undocumented items

type Output = Less

fn compare<IM: InternalMarker>(&self, _: &PInt<P>) -> Self::Output

impl<Pl: Cmp<Pr> + Unsigned + NonZero, Pr: Unsigned + NonZero> Cmp<PInt<Pr>> for PInt<Pl>[+]

X <==> Y

[+] Show hidden undocumented items

type Output = <Pl as Cmp<Pr>>::Output

fn compare<IM: InternalMarker>(&self, rhs: &PInt<Pr>) -> Self::Output

impl<U: Unsigned + NonZero> Cmp<NInt<U>> for Z0[+]

0 > -X

[+] Show hidden undocumented items

type Output = Greater

fn compare<IM: InternalMarker>(&self, _: &NInt<U>) -> Self::Output

impl<U: Unsigned + NonZero> Cmp<PInt<U>> for Z0[+]

0 < X

[+] Show hidden undocumented items

type Output = Less

fn compare<IM: InternalMarker>(&self, _: &PInt<U>) -> Self::Output

impl<U: Unsigned + NonZero> Cmp<Z0> for NInt<U>[+]

-X < 0

[+] Show hidden undocumented items

type Output = Less

fn compare<IM: InternalMarker>(&self, _: &Z0) -> Self::Output

impl<U: Unsigned + NonZero> Cmp<Z0> for PInt<U>[+]

X > 0

[+] Show hidden undocumented items

type Output = Greater

fn compare<IM: InternalMarker>(&self, _: &Z0) -> Self::Output

impl<U: Unsigned, B: Bit> Cmp<UInt<U, B>> for UTerm[+]

Zero < Nonzero

[+] Show hidden undocumented items

type Output = Less

fn compare<IM: InternalMarker>(&self, _: &UInt<U, B>) -> Self::Output

impl<U: Unsigned, B: Bit> Cmp<UTerm> for UInt<U, B>[+]

Nonzero > Zero

[+] Show hidden undocumented items

type Output = Greater

fn compare<IM: InternalMarker>(&self, _: &UTerm) -> Self::Output

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B0>> for UInt<Ul, B0> where
    Ul: PrivateCmp<Ur, Equal>, [+]

UInt<Ul, B0> cmp with UInt<Ur, B0>: SoFar is Equal

[+] Show hidden undocumented items

type Output = PrivateCmpOut<Ul, Ur, Equal>

fn compare<IM: InternalMarker>(&self, rhs: &UInt<Ur, B0>) -> Self::Output

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B0>> for UInt<Ul, B1> where
    Ul: PrivateCmp<Ur, Greater>, [+]

UInt<Ul, B1> cmp with UInt<Ur, B0>: SoFar is Greater

[+] Show hidden undocumented items

type Output = PrivateCmpOut<Ul, Ur, Greater>

fn compare<IM: InternalMarker>(&self, rhs: &UInt<Ur, B0>) -> Self::Output

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B1>> for UInt<Ul, B0> where
    Ul: PrivateCmp<Ur, Less>, [+]

UInt<Ul, B0> cmp with UInt<Ur, B1>: SoFar is Less

[+] Show hidden undocumented items

type Output = PrivateCmpOut<Ul, Ur, Less>

fn compare<IM: InternalMarker>(&self, rhs: &UInt<Ur, B1>) -> Self::Output

impl<Ul: Unsigned, Ur: Unsigned> Cmp<UInt<Ur, B1>> for UInt<Ul, B1> where
    Ul: PrivateCmp<Ur, Equal>, [+]

UInt<Ul, B1> cmp with UInt<Ur, B1>: SoFar is Equal

[+] Show hidden undocumented items

type Output = PrivateCmpOut<Ul, Ur, Equal>

fn compare<IM: InternalMarker>(&self, rhs: &UInt<Ur, B1>) -> Self::Output