Trait sp_std::cmp::Ord

1.0.0 · source · []
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 { ... } }
Expand description

Trait for types that form a total order.

Implementations must be consistent with the PartialOrd implementation, and ensure max, min, and clamp are consistent with cmp:

  • partial_cmp(a, b) == Some(cmp(a, b)).
  • max(a, b) == max_by(a, b, cmp) (ensured by the default implementation).
  • min(a, b) == min_by(a, b, cmp) (ensured by the default implementation).
  • For a.clamp(min, max), see the method docs (ensured by the default implementation).

It’s easy to accidentally make cmp and partial_cmp disagree by deriving some of the traits and manually implementing others.

Corollaries

From the above and the requirements of PartialOrd, it follows that < defines a strict total order. This means that for all a, b and c:

  • exactly one of a < b, a == b or a > b is true; and
  • < is 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 discriminants. By default, the discriminant is smallest for variants at the top, and largest for variants at the bottom. Here’s an example:

#[derive(PartialEq, Eq, PartialOrd, Ord)]
enum E {
    Top,
    Bottom,
}

assert!(E::Top < E::Bottom);

However, manually setting the discriminants can override this default behavior:

#[derive(PartialEq, Eq, PartialOrd, Ord)]
enum E {
    Top = 2,
    Bottom = 1,
}

assert!(E::Bottom < E::Top);

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.

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

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

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));

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));

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);

Implementations on Foreign Types

Implements comparison of arrays lexicographically.

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.

Implements comparison of vectors lexicographically.

Implementors

Implements ordering of vectors, lexicographically.

impl Ord for Error

impl Ord for Characters

impl Ord for ForWhat

impl<T, const CAP: usize> Ord for ArrayVec<T, CAP> where
    T: Ord

impl<const CAP: usize> Ord for ArrayString<CAP>

impl<T: Ord> Ord for CapacityError<T>

impl<'a> Ord for Components<'a>

impl Ord for Path

impl Ord for PathBuf

impl<O, V> Ord for BitArray<O, V> where
    O: BitOrder,
    V: BitView

impl<R: Ord> Ord for BitIdx<R> where
    R: BitRegister

impl<R: Ord> Ord for BitIdxError<R> where
    R: BitRegister

impl<R: Ord> Ord for BitTail<R> where
    R: BitRegister

impl<R: Ord> Ord for BitPos<R> where
    R: BitRegister

impl<R: Ord> Ord for BitSel<R> where
    R: BitRegister

impl<R: Ord> Ord for BitMask<R> where
    R: BitRegister

impl Ord for Const

impl Ord for Mut

impl Ord for Lsb0

impl Ord for Msb0

impl<M, T> Ord for Address<M, T> where
    M: Mutability,
    T: BitStore

impl<T: Ord> Ord for AddressError<T> where
    T: BitStore

impl<M, O, T> Ord for BitRef<'_, M, O, T> where
    M: Mutability,
    O: BitOrder,
    T: BitStore

impl<M, O, T> Ord for BitPtr<M, O, T> where
    M: Mutability,
    O: BitOrder,
    T: BitStore

impl<T: Ord> Ord for BitPtrError<T> where
    T: BitStore,
    T::Mem: Ord

impl<T: Ord> Ord for BitSpanError<T> where
    T: BitStore

impl<'a, O: Ord, T: Ord> Ord for IterOnes<'a, O, T> where
    O: BitOrder,
    T: BitStore

impl<'a, O: Ord, T: Ord> Ord for IterZeros<'a, O, T> where
    O: BitOrder,
    T: BitStore

impl<O, T> Ord for BitSlice<O, T> where
    O: BitOrder,
    T: BitStore

impl<O, T> Ord for BitBox<O, T> where
    O: BitOrder,
    T: BitStore

impl<O, T> Ord for BitVec<O, T> where
    O: BitOrder,
    T: BitStore

impl Ord for BString

impl Ord for BStr

impl Ord for BigEndian

impl Ord for LittleEndian

impl Ord for Bytes

impl Ord for BytesMut

impl Ord for NaiveDate

impl Ord for IsoWeek

impl Ord for NaiveTime

impl<Tz: TimeZone> Ord for Date<Tz>

impl<Tz: TimeZone> Ord for DateTime<Tz>

impl<const S: usize> Ord for Cid<S>

impl Ord for Version

impl Ord for ErrorKind

impl Ord for Block

impl Ord for Value

impl Ord for Inst

impl Ord for StackSlot

impl Ord for GlobalValue

impl Ord for Constant

impl Ord for Immediate

impl Ord for JumpTable

impl Ord for FuncRef

impl Ord for SigRef

impl Ord for Heap

impl Ord for Table

impl Ord for AnyEntity

impl Ord for MachLabel

impl<T: Ord + ReservedValue> Ord for PackedOption<T>

impl Ord for FuncIndex

impl Ord for TableIndex

impl Ord for GlobalIndex

impl Ord for MemoryIndex

impl Ord for DataIndex

impl Ord for ElemIndex

impl Ord for TypeIndex

impl Ord for ModuleIndex

impl Ord for EventIndex

impl Ord for EntityIndex

impl<T: ?Sized + Pointable> Ord for Shared<'_, T>

impl<L: Ord, R: Ord> Ord for Either<L, R>

impl Ord for Errno

impl<T: Ord> Ord for AssertAsync<T>

impl<T: Ord> Ord for AllowStdIo<T>

impl<T: Ord, N> Ord for GenericArray<T, N> where
    N: ArrayLength<T>, 

impl Ord for Register

impl<T: Ord> Ord for DebugInfoOffset<T>

impl<T: Ord> Ord for DebugTypesOffset<T>

impl<T: Ord> Ord for UnitSectionOffset<T>

impl Ord for SectionId

impl Ord for DwUt

impl Ord for DwCfa

impl Ord for DwChildren

impl Ord for DwTag

impl Ord for DwAt

impl Ord for DwForm

impl Ord for DwAte

impl Ord for DwLle

impl Ord for DwDs

impl Ord for DwEnd

impl Ord for DwAccess

impl Ord for DwVis

impl Ord for DwVirtuality

impl Ord for DwLang

impl Ord for DwAddr

impl Ord for DwId

impl Ord for DwCc

impl Ord for DwInl

impl Ord for DwOrd

impl Ord for DwDsc

impl Ord for DwIdx

impl Ord for DwDefaulted

impl Ord for DwLns

impl Ord for DwLne

impl Ord for DwLnct

impl Ord for DwMacro

impl Ord for DwRle

impl Ord for DwOp

impl Ord for DwEhPe

impl Ord for ArangeEntry

impl Ord for ColumnType

impl<T: Ord> Ord for UnitOffset<T>

impl Ord for HeaderValue

impl Ord for StatusCode

impl Ord for Version

impl Ord for HttpDate

impl Ord for IfEvent

impl Ord for IpNetwork

impl Ord for Ipv4Network

impl Ord for Ipv6Network

impl Ord for IpAddrRange

impl Ord for IpNet

impl Ord for Ipv4Net

impl Ord for Ipv6Net

impl Ord for IpSubnets

impl Ord for Ipv4Subnets

impl Ord for Ipv6Subnets

impl Ord for PeerId

impl Ord for ListenerId

impl Ord for ConnectionId

impl Ord for TopicHash

impl<H: Ord + Hasher> Ord for Topic<H>

impl Ord for MessageId

impl Ord for Distance

impl Ord for AddressScore

impl Ord for KeepAlive

impl<K: Hash + Eq + Ord, V: Ord, S: BuildHasher> Ord for LinkedHashMap<K, V, S>

impl<'k> Ord for Key<'k>

impl Ord for Level

impl Ord for LevelFilter

impl<'a> Ord for Metadata<'a>

impl<'a> Ord for MetadataBuilder<'a>

impl Ord for Bytes

impl Ord for Words

impl Ord for Pages

impl Ord for Words

impl Ord for Pages

impl Ord for ByteSlice

impl Ord for ByteVec

impl Ord for Type

impl Ord for Tag

impl Ord for PollOpt

impl Ord for Ready

impl Ord for UnixReady

impl Ord for Token

impl<const S: usize> Ord for Multihash<S>

impl Ord for Sign

impl Ord for BigInt

impl Ord for BigUint

impl<T: Clone + Integer> Ord for Ratio<T>

impl<E: Ord + Endian> Ord for U16Bytes<E>

impl<E: Ord + Endian> Ord for U32Bytes<E>

impl<E: Ord + Endian> Ord for U64Bytes<E>

impl<E: Ord + Endian> Ord for I16Bytes<E>

impl<E: Ord + Endian> Ord for I32Bytes<E>

impl<E: Ord + Endian> Ord for I64Bytes<E>

impl<O, T: ?Sized> Ord for OwningRef<O, T> where
    T: Ord

impl<O, T: ?Sized> Ord for OwningRefMut<O, T> where
    T: Ord

impl Ord for Multiaddr

impl<T: Ord> Ord for Compact<T>

impl<'i> Ord for Position<'i>

impl Ord for Rule

impl Ord for U128

impl Ord for U256

impl Ord for U512

impl Ord for H128

impl Ord for H160

impl Ord for H256

impl Ord for H512

impl Ord for LineColumn

impl Ord for Ident

impl Ord for LabelPair

impl Ord for InstIx

impl Ord for BlockIx

impl Ord for Reg

impl Ord for RealReg

impl Ord for VirtualReg

impl<R: Ord + WritableBase> Ord for Writable<R>

impl Ord for SpillSlot

impl Ord for Span

impl Ord for Position

impl Ord for Literal

impl Ord for Utf8Sequence

impl Ord for Utf8Range

impl Ord for Protection

impl<Hash: Ord, Number: Ord> Ord for EpochIdentifier<Hash, Number>

impl<T: Ord> Ord for SlotDuration<T>

impl Ord for SetId

impl Ord for PublicKey

impl Ord for VRFOutput

impl Ord for VRFInOut

impl Ord for Field

impl Ord for SigId

impl<A: Array> Ord for SmallVec<A> where
    A::Item: Ord

impl Ord for OpCode

impl<'a> Ord for Incoming<'a>

impl Ord for Data

impl Ord for Public

impl Ord for Public

impl Ord for Public

impl Ord for BigUint

impl Ord for Percent

impl Ord for PerU16

impl Ord for Permill

impl Ord for Perbill

impl Ord for Perquintill

impl Ord for FixedI64

impl Ord for FixedI128

impl Ord for FixedU128

impl Ord for Rational128

impl Ord for Slot

impl Ord for VRFProof

impl Ord for AccountId32

impl Ord for KeyTypeId

impl Ord for CryptoTypeId

impl Ord for Public

impl Ord for Public

impl Ord for Public

impl Ord for Timestamp

impl Ord for Duration

impl Ord for Bytes

impl Ord for OpaquePeerId

impl<'a> Ord for OpaqueDigestItemId<'a>

impl Ord for MultiSigner

impl Ord for StorageKey

impl Ord for StorageData

impl Ord for ChildInfo

impl Ord for Lifetime

impl Ord for Duration

impl Ord for Timespec

impl Ord for SteadyTime

impl Ord for Tm

impl<A: Array> Ord for ArrayVec<A> where
    A::Item: Ord

impl<'s, T> Ord for SliceVec<'s, T> where
    T: Ord

impl<A: Array> Ord for TinyVec<A> where
    A::Item: Ord

impl Ord for Instant

impl Ord for BytesCodec

impl Ord for LinesCodec

impl<T: Ord> Ord for AllowStdIo<T>

impl Ord for BytesCodec

impl Ord for LinesCodec

impl<T: Ord> Ord for Spanned<T>

impl Ord for Level

impl Ord for LevelFilter

impl Ord for Directive

impl Ord for FmtSpan

impl<'a> Ord for NibbleSlice<'a>

impl Ord for B0

impl Ord for B1

impl<U: Ord + Unsigned + NonZero> Ord for PInt<U>

impl<U: Ord + Unsigned + NonZero> Ord for NInt<U>

impl Ord for Z0

impl Ord for UTerm

impl<U: Ord, B: Ord> Ord for UInt<U, B>

impl Ord for ATerm

impl<V: Ord, A: Ord> Ord for TArr<V, A>

impl Ord for Greater

impl Ord for Less

impl Ord for Equal

impl<T: AsRef<str>> Ord for Ascii<T>

impl<T: AsRef<str>> Ord for UniCase<T>

impl Ord for Level

impl<S: Ord> Ord for Host<S>

impl Ord for Url

impl<V: Ord> Ord for VecMap<V>

impl Ord for Range

impl<'a> Ord for SectionCode<'a>

impl Ord for Span

impl Ord for StreamId

impl Ord for Packet