Trait core::cmp::Ord1.0.0[][src]

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

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

Trait for types that form a total order.

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

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:

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
    }
}
Run

Required methods

#[must_use]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);
Run
Loading content...

Provided methods

#[must_use]fn max(self, other: Self) -> Self where
    Self: Sized
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));
Run

#[must_use]fn min(self, other: Self) -> Self where
    Self: Sized
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));
Run

#[must_use]fn clamp(self, min: Self, max: Self) -> Self where
    Self: Sized
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);
Run
Loading content...

Implementors

impl Ord for ![src]

impl Ord for ()[src]

impl Ord for Ordering[src]

impl Ord for Infallible1.34.0[src]

impl Ord for TypeId[src]

impl Ord for CpuidResult1.27.0[src]

This is supported on x86 or x86-64 only.

impl Ord for Error[src]

impl Ord for PhantomPinned1.33.0[src]

impl Ord for NonZeroI81.34.0[src]

impl Ord for NonZeroI161.34.0[src]

impl Ord for NonZeroI321.34.0[src]

impl Ord for NonZeroI641.34.0[src]

impl Ord for NonZeroI1281.34.0[src]

impl Ord for NonZeroIsize1.34.0[src]

impl Ord for NonZeroU81.28.0[src]

impl Ord for NonZeroU161.28.0[src]

impl Ord for NonZeroU321.28.0[src]

impl Ord for NonZeroU641.28.0[src]

impl Ord for NonZeroU1281.28.0[src]

impl Ord for NonZeroUsize1.28.0[src]

impl Ord for NoneError[src]

impl Ord for Duration1.3.0[src]

impl Ord for bool[src]

impl Ord for char[src]

impl Ord for i8[src]

impl Ord for i16[src]

impl Ord for i32[src]

impl Ord for i64[src]

impl Ord for i128[src]

impl Ord for isize[src]

impl Ord for str[src]

Implements ordering of strings.

Strings are ordered lexicographically by their byte values. This orders Unicode code points based on their positions in the code charts. This is not necessarily the same as "alphabetical" order, which varies by language and locale. Sorting strings according to culturally-accepted standards requires locale-specific data that is outside the scope of the str type.

impl Ord for u8[src]

impl Ord for u16[src]

impl Ord for u32[src]

impl Ord for u64[src]

impl Ord for u128[src]

impl Ord for usize[src]

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

impl<A> Ord for (A,) where
    A: Ord + ?Sized
[src]

impl<A: Ord, B> Ord for (A, B) where
    B: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C> Ord for (A, B, C) where
    C: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D> Ord for (A, B, C, D) where
    D: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E> Ord for (A, B, C, D, E) where
    E: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E: Ord, F> Ord for (A, B, C, D, E, F) where
    F: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E: Ord, F: Ord, G> Ord for (A, B, C, D, E, F, G) where
    G: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E: Ord, F: Ord, G: Ord, H> Ord for (A, B, C, D, E, F, G, H) where
    H: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E: Ord, F: Ord, G: Ord, H: Ord, I> Ord for (A, B, C, D, E, F, G, H, I) where
    I: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E: Ord, F: Ord, G: Ord, H: Ord, I: Ord, J> Ord for (A, B, C, D, E, F, G, H, I, J) where
    J: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E: Ord, F: Ord, G: Ord, H: Ord, I: Ord, J: Ord, K> Ord for (A, B, C, D, E, F, G, H, I, J, K) where
    K: Ord + ?Sized
[src]

impl<A: Ord, B: Ord, C: Ord, D: Ord, E: Ord, F: Ord, G: Ord, H: Ord, I: Ord, J: Ord, K: Ord, L> Ord for (A, B, C, D, E, F, G, H, I, J, K, L) where
    L: Ord + ?Sized
[src]

impl<A: ?Sized> Ord for &A where
    A: Ord
[src]

impl<A: ?Sized> Ord for &mut A where
    A: Ord
[src]

impl<P: Deref<Target: Ord>> Ord for Pin<P>1.41.0[src]

impl<Ret> Ord for extern "C" fn() -> Ret1.4.0[src]

impl<Ret> Ord for fn() -> Ret1.4.0[src]

impl<Ret> Ord for unsafe extern "C" fn() -> Ret1.4.0[src]

impl<Ret> Ord for unsafe fn() -> Ret1.4.0[src]

impl<Ret, A> Ord for extern "C" fn(_: A) -> Ret1.4.0[src]

impl<Ret, A> Ord for extern "C" fn(_: A, ...) -> Ret1.4.0[src]

impl<Ret, A> Ord for fn(_: A) -> Ret1.4.0[src]

impl<Ret, A> Ord for unsafe extern "C" fn(_: A) -> Ret1.4.0[src]

impl<Ret, A> Ord for unsafe extern "C" fn(_: A, ...) -> Ret1.4.0[src]

impl<Ret, A> Ord for unsafe fn(_: A) -> Ret1.4.0[src]

impl<Ret, A, B> Ord for extern "C" fn(_: A, _: B) -> Ret1.4.0[src]

impl<Ret, A, B> Ord for extern "C" fn(_: A, _: B, ...) -> Ret1.4.0[src]

impl<Ret, A, B> Ord for fn(_: A, _: B) -> Ret1.4.0[src]

impl<Ret, A, B> Ord for unsafe extern "C" fn(_: A, _: B) -> Ret1.4.0[src]

impl<Ret, A, B> Ord for unsafe extern "C" fn(_: A, _: B, ...) -> Ret1.4.0[src]

impl<Ret, A, B> Ord for unsafe fn(_: A, _: B) -> Ret1.4.0[src]

impl<Ret, A, B, C> Ord for extern "C" fn(_: A, _: B, _: C) -> Ret1.4.0[src]

impl<Ret, A, B, C> Ord for extern "C" fn(_: A, _: B, _: C, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C> Ord for fn(_: A, _: B, _: C) -> Ret1.4.0[src]

impl<Ret, A, B, C> Ord for unsafe extern "C" fn(_: A, _: B, _: C) -> Ret1.4.0[src]

impl<Ret, A, B, C> Ord for unsafe extern "C" fn(_: A, _: B, _: C, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C> Ord for unsafe fn(_: A, _: B, _: C) -> Ret1.4.0[src]

impl<Ret, A, B, C, D> Ord for extern "C" fn(_: A, _: B, _: C, _: D) -> Ret1.4.0[src]

impl<Ret, A, B, C, D> Ord for extern "C" fn(_: A, _: B, _: C, _: D, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D> Ord for fn(_: A, _: B, _: C, _: D) -> Ret1.4.0[src]

impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D) -> Ret1.4.0[src]

impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D> Ord for unsafe fn(_: A, _: B, _: C, _: D) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E> Ord for fn(_: A, _: B, _: C, _: D, _: E) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, _: L) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, _: L, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, _: L) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, _: L) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, _: L, ...) -> Ret1.4.0[src]

impl<Ret, A, B, C, D, E, F, G, H, I, J, K, L> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H, _: I, _: J, _: K, _: L) -> Ret1.4.0[src]

impl<T: Ord + Copy> Ord for Cell<T>1.10.0[src]

impl<T: Ord + ?Sized> Ord for ManuallyDrop<T>1.20.0[src]

impl<T: Ord> Ord for Option<T>[src]

impl<T: Ord> Ord for Poll<T>1.36.0[src]

impl<T: Ord> Ord for Reverse<T>1.19.0[src]

impl<T: Ord> Ord for Wrapping<T>[src]

impl<T: Ord> Ord for [T][src]

Implements comparison of vectors lexicographically.

impl<T: Ord, E: Ord> Ord for Result<T, E>[src]

impl<T: Ord, const N: usize> Ord for [T; N][src]

Implements comparison of arrays lexicographically.

impl<T: ?Sized + Ord> Ord for RefCell<T>1.10.0[src]

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

Panics

Panics if the value in either RefCell is currently borrowed.

impl<T: ?Sized> Ord for *const T[src]

impl<T: ?Sized> Ord for *mut T[src]

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

impl<T: ?Sized> Ord for NonNull<T>1.25.0[src]

impl<Y: Ord, R: Ord> Ord for GeneratorState<Y, R>[src]

Loading content...