1.0.0[−][src]Trait core::cmp::Ord
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
ora > b
is true; and - transitive,
a < b
andb < c
impliesa < 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
Provided methods
fn max(self, other: Self) -> Self where
Self: Sized,
1.21.0
Self: Sized,
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 where
Self: Sized,
1.21.0
Self: Sized,
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 where
Self: Sized,
Self: Sized,
Implementors
impl Ord for !
[src]
impl Ord for ()
[src]
impl Ord for Ordering
[src]
impl Ord for Infallible
[src]
impl Ord for TypeId
[src]
impl Ord for CpuidResult
[src]
fn cmp(&self, other: &CpuidResult) -> Ordering
[src]
impl Ord for UnicodeVersion
[src]
fn cmp(&self, other: &UnicodeVersion) -> Ordering
[src]
impl Ord for Error
[src]
impl Ord for PhantomPinned
[src]
fn cmp(&self, other: &PhantomPinned) -> 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]
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]
impl Ord for NonZeroUsize
[src]
fn cmp(&self, other: &NonZeroUsize) -> Ordering
[src]
impl Ord for NoneError
[src]
impl Ord for Duration
[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: ?Sized> Ord for &'_ A where
A: Ord,
[src]
A: Ord,
impl<'_, A: ?Sized> Ord for &'_ mut A where
A: Ord,
[src]
A: Ord,
impl<A> Ord for (A,) where
A: Ord + ?Sized,
[src]
A: Ord + ?Sized,
impl<A: Ord, B> Ord for (A, B) where
B: Ord + ?Sized,
[src]
B: Ord + ?Sized,
impl<A: Ord, B: Ord, C> Ord for (A, B, C) where
C: Ord + ?Sized,
[src]
C: Ord + ?Sized,
impl<A: Ord, B: Ord, C: Ord, D> Ord for (A, B, C, D) where
D: Ord + ?Sized,
[src]
D: Ord + ?Sized,
impl<A: Ord, B: Ord, C: Ord, D: Ord, E> Ord for (A, B, C, D, E) where
E: Ord + ?Sized,
[src]
E: Ord + ?Sized,
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]
F: Ord + ?Sized,
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]
G: Ord + ?Sized,
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]
H: Ord + ?Sized,
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]
I: Ord + ?Sized,
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]
J: Ord + ?Sized,
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]
K: Ord + ?Sized,
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]
L: Ord + ?Sized,
impl<P: Ord> Ord for Pin<P>
[src]
impl<Ret> Ord for extern "C" fn() -> Ret
[src]
impl<Ret> Ord for fn() -> Ret
[src]
impl<Ret> Ord for unsafe extern "C" fn() -> Ret
[src]
impl<Ret> Ord for unsafe fn() -> Ret
[src]
impl<Ret, A> Ord for extern "C" fn(_: A) -> Ret
[src]
impl<Ret, A> Ord for extern "C" fn(_: A, _: ...) -> Ret
[src]
impl<Ret, A> Ord for fn(_: A) -> Ret
[src]
impl<Ret, A> Ord for unsafe extern "C" fn(_: A) -> Ret
[src]
impl<Ret, A> Ord for unsafe extern "C" fn(_: A, _: ...) -> Ret
[src]
impl<Ret, A> Ord for unsafe fn(_: A) -> Ret
[src]
impl<Ret, A, B> Ord for extern "C" fn(_: A, _: B) -> Ret
[src]
impl<Ret, A, B> Ord for extern "C" fn(_: A, _: B, _: ...) -> Ret
[src]
impl<Ret, A, B> Ord for fn(_: A, _: B) -> Ret
[src]
impl<Ret, A, B> Ord for unsafe extern "C" fn(_: A, _: B) -> Ret
[src]
impl<Ret, A, B> Ord for unsafe extern "C" fn(_: A, _: B, _: ...) -> Ret
[src]
impl<Ret, A, B> Ord for unsafe fn(_: A, _: B) -> Ret
[src]
impl<Ret, A, B, C> Ord for extern "C" fn(_: A, _: B, _: C) -> Ret
[src]
impl<Ret, A, B, C> Ord for extern "C" fn(_: A, _: B, _: C, _: ...) -> Ret
[src]
impl<Ret, A, B, C> Ord for fn(_: A, _: B, _: C) -> Ret
[src]
impl<Ret, A, B, C> Ord for unsafe extern "C" fn(_: A, _: B, _: C) -> Ret
[src]
impl<Ret, A, B, C> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: ...) -> Ret
[src]
impl<Ret, A, B, C> Ord for unsafe fn(_: A, _: B, _: C) -> Ret
[src]
impl<Ret, A, B, C, D> Ord for extern "C" fn(_: A, _: B, _: C, _: D) -> Ret
[src]
impl<Ret, A, B, C, D> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D> Ord for fn(_: A, _: B, _: C, _: D) -> Ret
[src]
impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D) -> Ret
[src]
impl<Ret, A, B, C, D> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D> Ord for unsafe fn(_: A, _: B, _: C, _: D) -> Ret
[src]
impl<Ret, A, B, C, D, E> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E) -> Ret
[src]
impl<Ret, A, B, C, D, E> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D, E> Ord for fn(_: A, _: B, _: C, _: D, _: E) -> Ret
[src]
impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E) -> Ret
[src]
impl<Ret, A, B, C, D, E> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D, E> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E) -> Ret
[src]
impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret
[src]
impl<Ret, A, B, C, D, E, F> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D, E, F> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret
[src]
impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret
[src]
impl<Ret, A, B, C, D, E, F> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D, E, F> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F) -> Ret
[src]
impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G) -> Ret
[src]
impl<Ret, A, B, C, D, E, F, G> Ord for extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D, E, F, G> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G) -> Ret
[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]
impl<Ret, A, B, C, D, E, F, G> Ord for unsafe extern "C" fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: ...) -> Ret
[src]
impl<Ret, A, B, C, D, E, F, G> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G) -> Ret
[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]
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]
impl<Ret, A, B, C, D, E, F, G, H> Ord for fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H) -> Ret
[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]
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]
impl<Ret, A, B, C, D, E, F, G, H> Ord for unsafe fn(_: A, _: B, _: C, _: D, _: E, _: F, _: G, _: H) -> Ret
[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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
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]
impl<T: Ord + Copy> Ord for Cell<T>
[src]
impl<T: Ord + ?Sized> Ord for ManuallyDrop<T>
[src]
fn cmp(&self, other: &ManuallyDrop<T>) -> Ordering
[src]
impl<T: Ord> Ord for Option<T>
[src]
impl<T: Ord> Ord for Poll<T>
[src]
impl<T: Ord> Ord for Reverse<T>
[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] where
[T; N]: LengthAtMost32,
[src]
[T; N]: LengthAtMost32,
impl<T: ?Sized + Ord> Ord for RefCell<T>
[src]
fn cmp(&self, other: &RefCell<T>) -> Ordering
[src]
Panics
Panics if the value in either RefCell
is currently borrowed.