Trait nom::lib::std::prelude::v1::rust_2018::Ord1.0.0[−][src]

pub trait Ord: Eq + PartialOrd<Self> {
    #[must_use]
    pub fn cmp(&self, other: &Self) -> Ordering;

    #[must_use]
    pub fn max(self, other: Self) -> Self { ... }
    #[must_use]
    pub fn min(self, other: Self) -> Self { ... }
    #[must_use]
    pub fn clamp(self, min: Self, max: Self) -> Self { ... }
}

[−]

Trait for types that form a total order.

An order is a total order if it is (for all a, b and c):

total and asymmetric: exactly one of a < b, a == b or a > b is true; and
transitive, a < b and b < c implies a < c. The same must hold for both == and >.

Derivable

This trait can be used with #[derive]. When derived on structs, it will produce a lexicographic ordering based on the top-to-bottom declaration order of the struct’s members. When derived on enums, variants are ordered by their top-to-bottom discriminant order.

Lexicographical comparison

Lexicographical comparison is an operation with the following properties:

Two sequences are compared element by element.
The first mismatching element defines which sequence is lexicographically less or greater than the other.
If one sequence is a prefix of another, the shorter sequence is lexicographically less than the other.
If two sequence have equivalent elements and are of the same length, then the sequences are lexicographically equal.
An empty sequence is lexicographically less than any non-empty sequence.
Two empty sequences are lexicographically equal.

How can I implement `Ord`?

Ord requires that the type also be PartialOrd and Eq (which requires PartialEq).

Then you must define an implementation for cmp. You may find it useful to use cmp on your type’s fields.

Implementations of PartialEq, PartialOrd, and Ord must agree with each other. That is, a.cmp(b) == Ordering::Equal if and only if a == b and Some(a.cmp(b)) == a.partial_cmp(b) for all a and b. It’s easy to accidentally make them disagree by deriving some of the traits and manually implementing others.

Here’s an example where you want to sort people by height only, disregarding id and name:

use std::cmp::Ordering;

#[derive(Eq)]
struct Person {
    id: u32,
    name: String,
    height: u32,
}

impl Ord for Person {
    fn cmp(&self, other: &Self) -> Ordering {
        self.height.cmp(&other.height)
    }
}

impl PartialOrd for Person {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl PartialEq for Person {
    fn eq(&self, other: &Self) -> bool {
        self.height == other.height
    }
}

Required methods

`#[must_use] pub fn cmp(&self, other: &Self) -> Ordering`[src][−]

This method returns an Ordering between self and other.

By convention, self.cmp(&other) returns the ordering matching the expression self <operator> other if true.

Examples

use std::cmp::Ordering;

assert_eq!(5.cmp(&10), Ordering::Less);
assert_eq!(10.cmp(&5), Ordering::Greater);
assert_eq!(5.cmp(&5), Ordering::Equal);

Provided methods

`#[must_use] pub fn max(self, other: Self) -> Self`1.21.0[src][−]

Compares and returns the maximum of two values.

Returns the second argument if the comparison determines them to be equal.

Examples

assert_eq!(2, 1.max(2));
assert_eq!(2, 2.max(2));

`#[must_use] pub fn min(self, other: Self) -> Self`1.21.0[src][−]

Compares and returns the minimum of two values.

Returns the first argument if the comparison determines them to be equal.

Examples

assert_eq!(1, 1.min(2));
assert_eq!(2, 2.min(2));

`#[must_use] pub fn clamp(self, min: Self, max: Self) -> Self`1.50.0[src][−]

Restrict a value to a certain interval.

Returns max if self is greater than max, and min if self is less than min. Otherwise this returns self.

Panics

Panics if min > max.

Examples

assert!((-3).clamp(-2, 1) == -2);
assert!(0.clamp(-2, 1) == 0);
assert!(2.clamp(-2, 1) == 1);

Trait nom::lib::std::prelude::v1::rust_2018::Ord⎘1.0.0[−][src]

Required methods

#[must_use]pub fn cmp(&self, other: &Self) -> Ordering[src][−]

Provided methods

#[must_use]pub fn max(self, other: Self) -> Self1.21.0[src][−]

#[must_use]pub fn min(self, other: Self) -> Self1.21.0[src][−]

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self1.50.0[src][−]

Implementations on Foreign Types

impl Ord for NonZeroI16[src][−]

pub fn cmp(&self, other: &NonZeroI16) -> Ordering[src]

impl Ord for CpuidResult[src][−]

pub fn cmp(&self, other: &CpuidResult) -> Ordering[src]

impl Ord for NonZeroI32[src][−]

pub fn cmp(&self, other: &NonZeroI32) -> Ordering[src]

impl Ord for NonZeroI128[src][−]

pub fn cmp(&self, other: &NonZeroI128) -> Ordering[src]

impl Ord for NonZeroI64[src][−]

pub fn cmp(&self, other: &NonZeroI64) -> Ordering[src]

impl<T> Ord for PhantomData<T> where T: ?Sized, [src][−]

pub fn cmp(&self, _other: &PhantomData<T>) -> Ordering[src]

impl Ord for NonZeroIsize[src][−]

pub fn cmp(&self, other: &NonZeroIsize) -> Ordering[src]

impl Ord for NonZeroU64[src][−]

pub fn cmp(&self, other: &NonZeroU64) -> Ordering[src]

impl Ord for Duration[src][−]

pub fn cmp(&self, other: &Duration) -> Ordering[src]

impl Ord for NonZeroUsize[src][−]

pub fn cmp(&self, other: &NonZeroUsize) -> Ordering[src]

impl Ord for NonZeroU32[src][−]

pub fn cmp(&self, other: &NonZeroU32) -> Ordering[src]

impl<T> Ord for Wrapping<T> where T: Ord, [src][−]

pub fn cmp(&self, other: &Wrapping<T>) -> Ordering[src]

impl<T> Ord for Poll<T> where T: Ord, [src][−]

pub fn cmp(&self, other: &Poll<T>) -> Ordering[src]

impl<'a> Ord for Location<'a>[src][−]

pub fn cmp(&self, other: &Location<'a>) -> Ordering[src]

impl<T> Ord for NonNull<T> where T: ?Sized, [src][−]

pub fn cmp(&self, other: &NonNull<T>) -> Ordering[src]

impl<P> Ord for Pin<P> where P: Deref, <P as Deref>::Target: Ord, [src][−]

pub fn cmp(&self, other: &Pin<P>) -> Ordering[src]

impl Ord for NonZeroU8[src][−]

pub fn cmp(&self, other: &NonZeroU8) -> Ordering[src]

impl<T> Ord for Cell<T> where T: Ord + Copy, [src][−]

pub fn cmp(&self, other: &Cell<T>) -> Ordering[src]

impl Ord for PhantomPinned[src][−]

pub fn cmp(&self, other: &PhantomPinned) -> Ordering[src]

impl Ord for NonZeroU128[src][−]

pub fn cmp(&self, other: &NonZeroU128) -> Ordering[src]

impl Ord for TypeId[src][−]

pub fn cmp(&self, other: &TypeId) -> Ordering[src]

impl Ord for NonZeroU16[src][−]

pub fn cmp(&self, other: &NonZeroU16) -> Ordering[src]

impl<T> Ord for RefCell<T> where T: Ord + ?Sized, [src][−]

pub fn cmp(&self, other: &RefCell<T>) -> Ordering[src][−]

impl Ord for NonZeroI8[src][−]

pub fn cmp(&self, other: &NonZeroI8) -> Ordering[src]

impl<Dyn> Ord for DynMetadata<Dyn> where Dyn: ?Sized, [src][−]

pub fn cmp(&self, other: &DynMetadata<Dyn>) -> Ordering[src]

Implementors

impl Ord for ![src][+]

pub fn cmp(&self, &!) -> Ordering[src]

impl Ord for ()[src][+]

pub fn cmp(&self, _other: &()) -> Ordering[src]

impl Ord for Ordering[src][+]

pub fn cmp(&self, other: &Ordering) -> Ordering[src]

impl Ord for Infallible1.34.0[src][+]

pub fn cmp(&self, _other: &Infallible) -> Ordering[src]

impl Ord for Error[src][+]

pub fn cmp(&self, other: &Error) -> Ordering[src]

impl Ord for NoneError[src][+]

pub fn cmp(&self, other: &NoneError) -> Ordering[src]

impl Ord for bool[src][+]

pub fn cmp(&self, other: &bool) -> Ordering[src]

impl Ord for char[src][+]

pub fn cmp(&self, other: &char) -> Ordering[src]

impl Ord for i8[src][+]

pub fn cmp(&self, other: &i8) -> Ordering[src]

impl Ord for i16[src][+]

pub fn cmp(&self, other: &i16) -> Ordering[src]

impl Ord for i32[src][+]

Trait nom::lib::std::prelude::v1::rust_2018::Ord1.0.0[−][src]

`#[must_use] pub fn cmp(&self, other: &Self) -> Ordering`[src][−]

`#[must_use] pub fn max(self, other: Self) -> Self`1.21.0[src][−]

`#[must_use] pub fn min(self, other: Self) -> Self`1.21.0[src][−]

`#[must_use] pub fn clamp(self, min: Self, max: Self) -> Self`1.50.0[src][−]

`impl Ord for NonZeroI16`[src][−]

`pub fn cmp(&self, other: &NonZeroI16) -> Ordering`[src]

`impl Ord for CpuidResult`[src][−]

`pub fn cmp(&self, other: &CpuidResult) -> Ordering`[src]

`impl Ord for NonZeroI32`[src][−]

`pub fn cmp(&self, other: &NonZeroI32) -> Ordering`[src]

`impl Ord for NonZeroI128`[src][−]

`pub fn cmp(&self, other: &NonZeroI128) -> Ordering`[src]

`impl Ord for NonZeroI64`[src][−]

`pub fn cmp(&self, other: &NonZeroI64) -> Ordering`[src]

`impl<T> Ord for PhantomData<T> where T: ?Sized,` [src][−]

`pub fn cmp(&self, _other: &PhantomData<T>) -> Ordering`[src]

`impl Ord for NonZeroIsize`[src][−]

`pub fn cmp(&self, other: &NonZeroIsize) -> Ordering`[src]

`impl Ord for NonZeroU64`[src][−]

`pub fn cmp(&self, other: &NonZeroU64) -> Ordering`[src]

`impl Ord for Duration`[src][−]

`pub fn cmp(&self, other: &Duration) -> Ordering`[src]

`impl Ord for NonZeroUsize`[src][−]

`pub fn cmp(&self, other: &NonZeroUsize) -> Ordering`[src]

`impl Ord for NonZeroU32`[src][−]

`pub fn cmp(&self, other: &NonZeroU32) -> Ordering`[src]

`impl<T> Ord for Wrapping<T> where T: Ord,` [src][−]

`pub fn cmp(&self, other: &Wrapping<T>) -> Ordering`[src]

`impl<T> Ord for Poll<T> where T: Ord,` [src][−]

`pub fn cmp(&self, other: &Poll<T>) -> Ordering`[src]

`impl<'a> Ord for Location<'a>`[src][−]

`pub fn cmp(&self, other: &Location<'a>) -> Ordering`[src]

`impl<T> Ord for NonNull<T> where T: ?Sized,` [src][−]

`pub fn cmp(&self, other: &NonNull<T>) -> Ordering`[src]

`impl<P> Ord for Pin<P> where P: Deref, <P as Deref>::Target: Ord,` [src][−]

`pub fn cmp(&self, other: &Pin<P>) -> Ordering`[src]

`impl Ord for NonZeroU8`[src][−]

`pub fn cmp(&self, other: &NonZeroU8) -> Ordering`[src]

`impl<T> Ord for Cell<T> where T: Ord + Copy,` [src][−]

`pub fn cmp(&self, other: &Cell<T>) -> Ordering`[src]

`impl Ord for PhantomPinned`[src][−]

`pub fn cmp(&self, other: &PhantomPinned) -> Ordering`[src]

`impl Ord for NonZeroU128`[src][−]

`pub fn cmp(&self, other: &NonZeroU128) -> Ordering`[src]

`impl Ord for TypeId`[src][−]

`pub fn cmp(&self, other: &TypeId) -> Ordering`[src]

`impl Ord for NonZeroU16`[src][−]

`pub fn cmp(&self, other: &NonZeroU16) -> Ordering`[src]

`impl<T> Ord for RefCell<T> where T: Ord + ?Sized,` [src][−]

`pub fn cmp(&self, other: &RefCell<T>) -> Ordering`[src][−]

`impl Ord for NonZeroI8`[src][−]

`pub fn cmp(&self, other: &NonZeroI8) -> Ordering`[src]

`impl<Dyn> Ord for DynMetadata<Dyn> where Dyn: ?Sized,` [src][−]

`pub fn cmp(&self, other: &DynMetadata<Dyn>) -> Ordering`[src]

`impl Ord for !`[src][+]

`pub fn cmp(&self, &!) -> Ordering`[src]

`impl Ord for ()`[src][+]

`pub fn cmp(&self, _other: &()) -> Ordering`[src]

`impl Ord for Ordering`[src][+]

`pub fn cmp(&self, other: &Ordering) -> Ordering`[src]

`impl Ord for Infallible`1.34.0[src][+]

`pub fn cmp(&self, _other: &Infallible) -> Ordering`[src]

`impl Ord for Error`[src][+]

`pub fn cmp(&self, other: &Error) -> Ordering`[src]

`impl Ord for NoneError`[src][+]

`pub fn cmp(&self, other: &NoneError) -> Ordering`[src]

`impl Ord for bool`[src][+]

`pub fn cmp(&self, other: &bool) -> Ordering`[src]

`impl Ord for char`[src][+]

`pub fn cmp(&self, other: &char) -> Ordering`[src]

`impl Ord for i8`[src][+]

`pub fn cmp(&self, other: &i8) -> Ordering`[src]

`impl Ord for i16`[src][+]

`pub fn cmp(&self, other: &i16) -> Ordering`[src]

`impl Ord for i32`[src][+]

`pub fn cmp(&self, other: &i32) -> Ordering`[src]

`impl Ord for i64`[src][+]

`pub fn cmp(&self, other: &i64) -> Ordering`[src]

`impl Ord for i128`[src][+]