Trait std::cmp::Ord 1.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 == bora > bis true; and - transitive,
a < bandb < cimpliesa < 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 } }Run
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);Run
Provided methods
#[must_use]pub fn max(self, other: Self) -> Self1.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]pub fn min(self, other: Self) -> Self1.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]pub fn clamp(self, min: Self, max: Self) -> Self1.50.0[src]
Implementors
impl Ord for Infallible1.34.0[src]
impl Ord for Infallible1.34.0[src]pub fn cmp(&self, _other: &Infallible) -> Ordering[src]
impl Ord for SocketAddr[src]
impl Ord for SocketAddr[src]fn cmp(&self, other: &SocketAddr) -> Ordering[src]
impl Ord for str[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 PhantomPinned1.33.0[src]
impl Ord for PhantomPinned1.33.0[src]pub fn cmp(&self, other: &PhantomPinned) -> Ordering[src]
impl Ord for SocketAddrV41.45.0[src]
impl Ord for SocketAddrV41.45.0[src]fn cmp(&self, other: &SocketAddrV4) -> Ordering[src]
impl Ord for SocketAddrV61.45.0[src]
impl Ord for SocketAddrV61.45.0[src]fn cmp(&self, other: &SocketAddrV6) -> Ordering[src]
impl Ord for NonZeroI161.34.0[src]
impl Ord for NonZeroI161.34.0[src]pub fn cmp(&self, other: &NonZeroI16) -> Ordering[src]
impl Ord for NonZeroI321.34.0[src]
impl Ord for NonZeroI321.34.0[src]pub fn cmp(&self, other: &NonZeroI32) -> Ordering[src]
impl Ord for NonZeroI641.34.0[src]
impl Ord for NonZeroI641.34.0[src]pub fn cmp(&self, other: &NonZeroI64) -> Ordering[src]
impl Ord for NonZeroI1281.34.0[src]
impl Ord for NonZeroI1281.34.0[src]pub fn cmp(&self, other: &NonZeroI128) -> Ordering[src]
impl Ord for NonZeroIsize1.34.0[src]
impl Ord for NonZeroIsize1.34.0[src]pub fn cmp(&self, other: &NonZeroIsize) -> Ordering[src]
impl Ord for NonZeroU161.28.0[src]
impl Ord for NonZeroU161.28.0[src]pub fn cmp(&self, other: &NonZeroU16) -> Ordering[src]
impl Ord for NonZeroU321.28.0[src]
impl Ord for NonZeroU321.28.0[src]pub fn cmp(&self, other: &NonZeroU32) -> Ordering[src]
impl Ord for NonZeroU641.28.0[src]
impl Ord for NonZeroU641.28.0[src]pub fn cmp(&self, other: &NonZeroU64) -> Ordering[src]
impl Ord for NonZeroU1281.28.0[src]
impl Ord for NonZeroU1281.28.0[src]pub fn cmp(&self, other: &NonZeroU128) -> Ordering[src]
impl Ord for NonZeroUsize1.28.0[src]
impl Ord for NonZeroUsize1.28.0[src]pub fn cmp(&self, other: &NonZeroUsize) -> Ordering[src]
impl Ord for SystemTime1.8.0[src]
impl Ord for SystemTime1.8.0[src]fn cmp(&self, other: &SystemTime) -> Ordering[src]
impl<A, B, C, D, E> Ord for (A, B, C, D, E) where
C: Ord,
E: Ord + ?Sized,
B: Ord,
A: Ord,
D: Ord, [src]
impl<A, B, C, D, E> Ord for (A, B, C, D, E) where
C: Ord,
E: Ord + ?Sized,
B: Ord,
A: Ord,
D: Ord, [src]impl<A, B, C, D, E, F> Ord for (A, B, C, D, E, F) where
C: Ord,
F: Ord + ?Sized,
E: Ord,
B: Ord,
A: Ord,
D: Ord, [src]
impl<A, B, C, D, E, F> Ord for (A, B, C, D, E, F) where
C: Ord,
F: Ord + ?Sized,
E: Ord,
B: Ord,
A: Ord,
D: Ord, [src]impl<A, B, C, D, E, F, G> Ord for (A, B, C, D, E, F, G) where
C: Ord,
F: Ord,
E: Ord,
B: Ord,
A: Ord,
G: Ord + ?Sized,
D: Ord, [src]
impl<A, B, C, D, E, F, G> Ord for (A, B, C, D, E, F, G) where
C: Ord,
F: Ord,
E: Ord,
B: Ord,
A: Ord,
G: Ord + ?Sized,
D: Ord, [src]impl<A, B, C, D, E, F, G, H> Ord for (A, B, C, D, E, F, G, H) where
C: Ord,
F: Ord,
E: Ord,
H: Ord + ?Sized,
B: Ord,
A: Ord,
G: Ord,
D: Ord, [src]
impl<A, B, C, D, E, F, G, H> Ord for (A, B, C, D, E, F, G, H) where
C: Ord,
F: Ord,
E: Ord,
H: Ord + ?Sized,
B: Ord,
A: Ord,
G: Ord,
D: Ord, [src]impl<A, B, C, D, E, F, G, H, I> Ord for (A, B, C, D, E, F, G, H, I) where
C: Ord,
F: Ord,
I: Ord + ?Sized,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
G: Ord,
D: Ord, [src]
impl<A, B, C, D, E, F, G, H, I> Ord for (A, B, C, D, E, F, G, H, I) where
C: Ord,
F: Ord,
I: Ord + ?Sized,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
G: Ord,
D: Ord, [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
C: Ord,
F: Ord,
I: Ord,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
J: Ord + ?Sized,
G: Ord,
D: Ord, [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
C: Ord,
F: Ord,
I: Ord,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
J: Ord + ?Sized,
G: Ord,
D: Ord, [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
C: Ord,
F: Ord,
K: Ord + ?Sized,
I: Ord,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
J: Ord,
G: Ord,
D: Ord, [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
C: Ord,
F: Ord,
K: Ord + ?Sized,
I: Ord,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
J: Ord,
G: Ord,
D: Ord, [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
C: Ord,
F: Ord,
K: Ord,
I: Ord,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
J: Ord,
G: Ord,
D: Ord,
L: Ord + ?Sized, [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
C: Ord,
F: Ord,
K: Ord,
I: Ord,
E: Ord,
H: Ord,
B: Ord,
A: Ord,
J: Ord,
G: Ord,
D: Ord,
L: Ord + ?Sized, [src]impl<Dyn> Ord for DynMetadata<Dyn> where
Dyn: ?Sized, [src]
impl<Dyn> Ord for DynMetadata<Dyn> where
Dyn: ?Sized, [src]pub fn cmp(&self, other: &DynMetadata<Dyn>) -> Ordering[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, 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 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 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, 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 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 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 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, 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 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 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> 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> 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 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, 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 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 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 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> 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> 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 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, 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 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 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 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<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<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 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<T> Ord for LinkedList<T> where
T: Ord, [src]
impl<T> Ord for LinkedList<T> where
T: Ord, [src]pub fn cmp(&self, other: &LinkedList<T>) -> Ordering[src]
impl<T> Ord for PhantomData<T> where
T: ?Sized, [src]
impl<T> Ord for PhantomData<T> where
T: ?Sized, [src]pub fn cmp(&self, _other: &PhantomData<T>) -> Ordering[src]
impl<T> Ord for ManuallyDrop<T> where
T: Ord + ?Sized, 1.20.0[src]
impl<T> Ord for ManuallyDrop<T> where
T: Ord + ?Sized, 1.20.0[src]pub fn cmp(&self, other: &ManuallyDrop<T>) -> Ordering[src]
impl<T, A> Ord for Vec<T, A> where
T: Ord,
A: Allocator, [src]
impl<T, A> Ord for Vec<T, A> where
T: Ord,
A: Allocator, [src]Implements ordering of vectors, lexicographically.
impl<T, const N: usize> Ord for [T; N] where
T: Ord, [src]
impl<T, const N: usize> Ord for [T; N] where
T: Ord, [src]Implements comparison of arrays lexicographically.
impl<Y, R> Ord for GeneratorState<Y, R> where
R: Ord,
Y: Ord, [src]
impl<Y, R> Ord for GeneratorState<Y, R> where
R: Ord,
Y: Ord, [src]