std::cmp::Ord - Rust
Description: API documentation for the Rust `Ord` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Ord

# 1.0.0[−][src]Trait std::cmp::Ord

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

        fn max(self, other: Self) -> Self { ... }
        fn min(self, other: Self) -> Self { ... }
        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 antisymmetric: 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 `derive`d on structs, it will produce a lexicographic ordering based on the top-to-bottom declaration order of the struct's members. When `derive`d on enums, variants are ordered by their top-to-bottom declaration order.

## 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

### `fn cmp(&self, other: &Self) -> Ordering`

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

### `fn max(self, other: Self) -> Self`1.21.0

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

### `fn min(self, other: Self) -> Self`1.21.0

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

### `fn clamp(self, min: Self, max: Self) -> Self`

🔬 This is a nightly-only experimental API. (`clamp` #44095)

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

    #![feature(clamp)]

    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 Ordering`[src]

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

### `impl Ord for Infallible`[src]

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

### `impl Ord for ErrorKind`[src]

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

### `impl Ord for IpAddr`[src]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

### `impl Ord for isize`[src]

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

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

#### `fn cmp(&self, &!) -> Ordering`[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.

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

### `impl Ord for u128`[src]

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

### `impl Ord for u16`[src]

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

### `impl Ord for u32`[src]

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

### `impl Ord for u64`[src]

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

### `impl Ord for u8`[src]

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

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

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

### `impl Ord for usize`[src]

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

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

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

### `impl Ord for UnicodeVersion`[src]

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

### `impl Ord for CStr`[src]

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

### `impl Ord for CString`[src]

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

### `impl Ord for OsStr`[src]

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

### `impl Ord for OsString`[src]

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

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

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

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

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

### `impl Ord for Ipv4Addr`[src]

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

### `impl Ord for Ipv6Addr`[src]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

### `impl Ord for Path`[src]

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

### `impl Ord for PathBuf`[src]

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

### `impl Ord for String`[src]

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

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

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

### `impl Ord for Instant`[src]

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

### `impl Ord for SystemTime`[src]

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

### `impl<'_> Ord for Components<'_>`[src]

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

### `impl<'_> Ord for PrefixComponent<'_>`[src]

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

### `impl<'_, A> Ord for &'_ A where
A: Ord + ?Sized,` [src]

#### `fn cmp(&self, other: &&'_ A) -> Ordering`[src]

### `impl<'_, A> Ord for &'_ mut A where
A: Ord + ?Sized,` [src]

#### `fn cmp(&self, other: &&'_ mut A) -> Ordering`[src]

### `impl<'_, B> Ord for Cow<'_, B> where
B: Ord + ToOwned + ?Sized,` [src]

#### `fn cmp(&self, other: &Cow<'_, B>) -> Ordering`[src]

### `impl<'a> Ord for Component<'a>`[src]

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

### `impl<'a> Ord for Prefix<'a>`[src]

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

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

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

### `impl<A> Ord for VecDeque<A> where
A: Ord,` [src]

#### `fn cmp(&self, other: &VecDeque<A>) -> Ordering`[src]

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

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

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

#### `fn cmp(&self, other: &(A, B, C)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E, F)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E, F, G)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E, F, G, H)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E, F, G, H, I)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E, F, G, H, I, J)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E, F, G, H, I, J, K)) -> Ordering`[src]

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

#### `fn cmp(&self, other: &(A, B, C, D, E, F, G, H, I, J, K, L)) -> Ordering`[src]

### `impl<K, V> Ord for BTreeMap<K, V> where
K: Ord,
V: Ord,` [src]

#### `fn cmp(&self, other: &BTreeMap<K, V>) -> Ordering`[src]

### `impl<P> Ord for Pin<P> where
P: Ord,` [src]

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

### `impl<Ret> Ord for fn() -> Ret`[src]

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

### `impl<Ret> Ord for extern "C" fn() -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn() -> Ret) -> Ordering`[src]

### `impl<Ret> Ord for unsafe fn() -> Ret`[src]

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

### `impl<Ret> Ord for unsafe extern "C" fn() -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn() -> Ret) -> Ordering`[src]

### `impl<Ret, A> Ord for fn(A) -> Ret`[src]

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

### `impl<Ret, A> Ord for extern "C" fn(A) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A) -> Ret) -> Ordering`[src]

### `impl<Ret, A> Ord for extern "C" fn(A, VaListImpl) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, VaListImpl) -> Ret) -> Ordering`[src]

### `impl<Ret, A> Ord for unsafe fn(A) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A) -> Ret) -> Ordering`[src]

### `impl<Ret, A> Ord for unsafe extern "C" fn(A) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A) -> Ret) -> Ordering`[src]

### `impl<Ret, A> Ord for unsafe extern "C" fn(A, VaListImpl) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A, VaListImpl) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B> Ord for fn(A, B) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B> Ord for extern "C" fn(A, B) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B> Ord for extern "C" fn(A, B, VaListImpl) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, VaListImpl) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B> Ord for unsafe fn(A, B) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B> Ord for unsafe extern "C" fn(A, B) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A, B) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B> Ord for unsafe extern "C" fn(A, B, VaListImpl) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A, B, VaListImpl) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C> Ord for fn(A, B, C) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C> Ord for extern "C" fn(A, B, C) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C> Ord for extern "C" fn(A, B, C, VaListImpl) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C, VaListImpl) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C> Ord for unsafe fn(A, B, C) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B, C) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C> Ord for unsafe extern "C" fn(A, B, C) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A, B, C) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C> Ord for unsafe extern "C" fn(A, B, C, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D> Ord for fn(A, B, C, D) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D> Ord for extern "C" fn(A, B, C, D) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C, D) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D> Ord for extern "C" fn(A, B, C, D, VaListImpl) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C, D, VaListImpl) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D> Ord for unsafe fn(A, B, C, D) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B, C, D) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(A, B, C, D) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A, B, C, D) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(A, B, C, D, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E> Ord for fn(A, B, C, D, E) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E> Ord for extern "C" fn(A, B, C, D, E) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C, D, E) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E> Ord for extern "C" fn(A, B, C, D, E, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E> Ord for unsafe fn(A, B, C, D, E) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B, C, D, E) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(A, B, C, D, E) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A, B, C, D, E) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(A, B, C, D, E, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F> Ord for fn(A, B, C, D, E, F) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E, F) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(A, B, C, D, E, F) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C, D, E, F) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(A, B, C, D, E, F, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F> Ord for unsafe fn(A, B, C, D, E, F) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B, C, D, E, F) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(A, B, C, D, E, F) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe extern "C" fn(A, B, C, D, E, F) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(A, B, C, D, E, F, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G> Ord for fn(A, B, C, D, E, F, G) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E, F, G) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(A, B, C, D, E, F, G) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C, D, E, F, G) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(A, B, C, D, E, F, G, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G> Ord for unsafe fn(A, B, C, D, E, F, G) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B, C, D, E, F, G) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G> Ord for unsafe extern "C" fn(A, B, C, D, E, F, G, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G, H> Ord for fn(A, B, C, D, E, F, G, H) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E, F, G, H) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G, H> Ord for extern "C" fn(A, B, C, D, E, F, G, H) -> Ret`[src]

#### `fn cmp(&self, other: &extern "C" fn(A, B, C, D, E, F, G, H) -> Ret) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G, H> Ord for extern "C" fn(A, B, C, D, E, F, G, H, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe fn(A, B, C, D, E, F, G, H) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B, C, D, E, F, G, H) -> Ret) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<Ret, A, B, C, D, E, F, G, H, I> Ord for fn(A, B, C, D, E, F, G, H, I) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E, F, G, H, I) -> Ret) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I, VaListImpl) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(&self, other: &unsafe fn(A, B, C, D, E, F, G, H, I) -> Ret) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, VaListImpl) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E, F, G, H, I, J) -> Ret) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I, J) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I, J, VaListImpl) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe fn(A, B, C, D, E, F, G, H, I, J) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, VaListImpl) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, VaListImpl) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, VaListImpl) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(&self, other: &fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L, VaListImpl) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret
) -> Ordering`[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) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L) -> Ret
) -> Ordering`[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, VaListImpl) -> Ret`[src]

#### `fn cmp(
&self,
other: &unsafe extern "C" fn(A, B, C, D, E, F, G, H, I, J, K, L, VaListImpl) -> Ret
) -> Ordering`[src]

### `impl<T> Ord for Option<T> where
T: Ord,` [src]

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

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

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

### `impl<T> Ord for *const T where
T: ?Sized,` [src]

#### `fn cmp(&self, other: &*const T) -> Ordering`[src]

### `impl<T> Ord for *mut T where
T: ?Sized,` [src]

#### `fn cmp(&self, other: &*mut T) -> Ordering`[src]

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

Implements comparison of vectors lexicographically.

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

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

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

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

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

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

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

# Panics

Panics if the value in either `RefCell` is currently borrowed.

### `impl<T> Ord for Reverse<T> where
T: Ord,` [src]

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

### `impl<T> Ord for BTreeSet<T> where
T: Ord,` [src]

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

### `impl<T> Ord for LinkedList<T> where
T: Ord,` [src]

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

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

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

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

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

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

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

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

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

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

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

Comparison for two `Rc`s.

The two are compared by calling `cmp()` on their inner values.

# Examples

    use std::rc::Rc;
    use std::cmp::Ordering;

    let five = Rc::new(5);

    assert_eq!(Ordering::Less, five.cmp(&Rc::new(6)));Run

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

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

Comparison for two `Arc`s.

The two are compared by calling `cmp()` on their inner values.

# Examples

    use std::sync::Arc;
    use std::cmp::Ordering;

    let five = Arc::new(5);

    assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));Run

### `impl<T> Ord for Vec<T> where
T: Ord,` [src]

Implements ordering of vectors, lexicographically.

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

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

#### `fn cmp(&self, other: &Result<T, E>) -> Ordering`[src]

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

#### `fn cmp(&self, other: &GeneratorState<Y, R>) -> Ordering`[src]

### `impl<const N: usize, T> Ord for [T; N] where
T: Ord,
[T; N]: LengthAtMost32,` [src]

#### `fn cmp(&self, other: &[T; N]) -> Ordering`[src]

Loading content...

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)