Trait kvarn::prelude::compact_str::core::cmp::Ord

1.0.0 · source ·
pub trait Ord: Eq + PartialOrd<Self> {
    // Required method
    fn cmp(&self, other: &Self) -> Ordering;

    // Provided methods
    fn max(self, other: Self) -> Self
       where Self: Sized { ... }
    fn min(self, other: Self) -> Self
       where Self: Sized { ... }
    fn clamp(self, min: Self, max: Self) -> Self
       where Self: Sized + PartialOrd<Self> { ... }
}
Available on non-crate feature miri-test-libstd only.
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§

source

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

Provided Methods§

1.21.0 · source

fn max(self, other: Self) -> Selfwhere 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));
1.21.0 · source

fn min(self, other: Self) -> Selfwhere 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));
1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

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

Implementors§

source§

impl Ord for Action

source§

impl Ord for ErrorKind

1.7.0 · source§

impl Ord for IpAddr

source§

impl Ord for SocketAddr

source§

impl Ord for RequestParseStage

1.34.0 · source§

impl Ord for Infallible

source§

impl Ord for Which

source§

impl Ord for Ordering

source§

impl Ord for log::Level

source§

impl Ord for log::LevelFilter

source§

impl Ord for Sign

source§

impl Ord for Direction

const: unstable · source§

impl Ord for bool

const: unstable · source§

impl Ord for char

const: unstable · source§

impl Ord for i8

const: unstable · source§

impl Ord for i16

const: unstable · source§

impl Ord for i32

const: unstable · source§

impl Ord for i64

const: unstable · source§

impl Ord for i128

const: unstable · source§

impl Ord for isize

const: unstable · source§

impl Ord for !

source§

impl Ord for str

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.

const: unstable · source§

impl Ord for u8

const: unstable · source§

impl Ord for u16

const: unstable · source§

impl Ord for u32

const: unstable · source§

impl Ord for u64

const: unstable · source§

impl Ord for u128

const: unstable · source§

impl Ord for ()

const: unstable · source§

impl Ord for usize

source§

impl Ord for Id

§

impl Ord for Bytes

§

impl Ord for BytesMut

§

impl Ord for OffsetDateTime

source§

impl Ord for Error

source§

impl Ord for HeaderValue

source§

impl Ord for Mime

source§

impl Ord for Ipv4Addr

source§

impl Ord for Ipv6Addr

1.45.0 · source§

impl Ord for SocketAddrV4

1.45.0 · source§

impl Ord for SocketAddrV6

1.8.0 · source§

impl Ord for kvarn::prelude::Instant

source§

impl Ord for Path

source§

impl Ord for PathBuf

source§

impl Ord for StatusCode

source§

impl Ord for Version

§

impl Ord for CompactString

source§

impl Ord for TypeId

1.27.0 · source§

impl Ord for CpuidResult

source§

impl Ord for CStr

1.33.0 · source§

impl Ord for PhantomPinned

1.34.0 · source§

impl Ord for NonZeroI8

1.34.0 · source§

impl Ord for NonZeroI16

1.34.0 · source§

impl Ord for NonZeroI32

1.34.0 · source§

impl Ord for NonZeroI64

1.34.0 · source§

impl Ord for NonZeroI128

1.34.0 · source§

impl Ord for NonZeroIsize

1.28.0 · source§

impl Ord for NonZeroU8

1.28.0 · source§

impl Ord for NonZeroU16

1.28.0 · source§

impl Ord for NonZeroU32

1.28.0 · source§

impl Ord for NonZeroU64

1.28.0 · source§

impl Ord for NonZeroU128

1.28.0 · source§

impl Ord for NonZeroUsize

const: unstable · source§

impl Ord for Alignment

1.3.0 · source§

impl Ord for kvarn::prelude::compact_str::core::time::Duration

1.64.0 · source§

impl Ord for CString

source§

impl Ord for String

source§

impl Ord for OsStr

source§

impl Ord for OsString

source§

impl Ord for Components<'_>

source§

impl Ord for PrefixComponent<'_>

1.8.0 · source§

impl Ord for SystemTime

source§

impl Ord for FixedBitSet

source§

impl Ord for BigInt

source§

impl Ord for BigUint

source§

impl Ord for petgraph::visit::dfsvisit::Time

source§

impl Ord for ATerm

source§

impl Ord for B0

source§

impl Ord for B1

source§

impl Ord for Z0

source§

impl Ord for Equal

source§

impl Ord for Greater

source§

impl Ord for Less

source§

impl Ord for UTerm

source§

impl Ord for Braced

source§

impl Ord for Hyphenated

source§

impl Ord for Simple

source§

impl Ord for Urn

source§

impl Ord for Uuid

§

impl Ord for ASN1DateTime

§

impl Ord for ASN1Time

§

impl Ord for ASN1TimeZone

§

impl Ord for AnyDelimiterCodec

§

impl Ord for BigEndian

§

impl Ord for BytesCodec

§

impl Ord for Certificate

§

impl Ord for ConnectionHandle

§

impl Ord for ConnectionId

§

impl Ord for Date

§

impl Ord for Dir

§

impl Ord for Duration

§

impl Ord for EventMask

§

impl Ord for FileTime

§

impl Ord for Flags

§

impl Ord for FsyncFlags

§

impl Ord for GeneralizedTime

§

impl Ord for IdleTimeout

§

impl Ord for Instant

§

impl Ord for Instant

§

impl Ord for Interest

§

impl Ord for Level

§

impl Ord for LevelFilter

§

impl Ord for LinesCodec

§

impl Ord for LittleEndian

§

impl Ord for Null

§

impl Ord for PrimitiveDateTime

§

impl Ord for ReadError

§

impl Ord for ReadableError

§

impl Ord for Ready

§

impl Ord for RecursiveMode

§

impl Ord for SendDatagramError

§

impl Ord for Side

§

impl Ord for StreamId

§

impl Ord for StreamId

§

impl Ord for Time

§

impl Ord for TimeoutFlags

§

impl Ord for Token

§

impl Ord for UtcOffset

§

impl Ord for UtcTime

§

impl Ord for VarInt

§

impl Ord for WatchDescriptor

§

impl Ord for WatchMask

§

impl Ord for WriteError

source§

impl<'a> Ord for Component<'a>

source§

impl<'a> Ord for Prefix<'a>

1.10.0 · source§

impl<'a> Ord for Location<'a>

source§

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

source§

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

source§

impl<'a> Ord for Name<'a>

source§

impl<'a, E, Ix> Ord for EdgeReference<'a, E, Ix>where E: Ord, Ix: Ord + IndexType,

source§

impl<'b, T> Ord for Ptr<'b, T>

§

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

source§

impl<A> Ord for &Awhere A: Ord + ?Sized,

source§

impl<A> Ord for &mut Awhere A: Ord + ?Sized,

§

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

§

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

§

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

source§

impl<B> Ord for Cow<'_, B>where B: Ord + ToOwned + ?Sized,

source§

impl<Dyn> Ord for DynMetadata<Dyn>where Dyn: ?Sized,

source§

impl<Ix> Ord for petgraph::adj::EdgeIndex<Ix>where Ix: Ord + IndexType,

source§

impl<Ix> Ord for petgraph::graph_impl::EdgeIndex<Ix>where Ix: Ord,

source§

impl<Ix> Ord for NodeIndex<Ix>where Ix: Ord,

source§

impl<K, V, A> Ord for BTreeMap<K, V, A>where K: Ord, V: Ord, A: Allocator + Clone,

1.41.0 · source§

impl<P> Ord for Pin<P>where P: Deref, <P as Deref>::Target: Ord,

1.4.0 · source§

impl<Ret, T> Ord for fn (T₁, T₂, …, Tₙ) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

1.4.0 · source§

impl<Ret, T> Ord for extern "C" fn (T₁, T₂, …, Tₙ) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

1.4.0 · source§

impl<Ret, T> Ord for extern "C" fn (T₁, T₂, …, Tₙ, ...) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

source§

impl<Ret, T> Ord for extern "C-unwind" fn (T₁, T₂, …, Tₙ) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

source§

impl<Ret, T> Ord for extern "C-unwind" fn (T₁, T₂, …, Tₙ, ...) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

1.4.0 · source§

impl<Ret, T> Ord for unsafe fn (T₁, T₂, …, Tₙ) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

1.4.0 · source§

impl<Ret, T> Ord for unsafe extern "C" fn (T₁, T₂, …, Tₙ) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

1.4.0 · source§

impl<Ret, T> Ord for unsafe extern "C" fn (T₁, T₂, …, Tₙ, ...) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

source§

impl<Ret, T> Ord for unsafe extern "C-unwind" fn (T₁, T₂, …, Tₙ) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

source§

impl<Ret, T> Ord for unsafe extern "C-unwind" fn (T₁, T₂, …, Tₙ, ...) -> Ret

This trait is implemented for function pointers with up to twelve arguments.

source§

impl<T> Ord for Option<T>where T: Ord,

1.36.0 · source§

impl<T> Ord for Poll<T>where T: Ord,

source§

impl<T> Ord for *const Twhere T: ?Sized,

source§

impl<T> Ord for *mut Twhere T: ?Sized,

source§

impl<T> Ord for [T]where T: Ord,

Implements comparison of vectors lexicographically.

const: unstable · source§

impl<T> Ord for (T₁, T₂, …, Tₙ)where T: Ord + ?Sized,

This trait is implemented for tuples up to twelve items long.

source§

impl<T> Ord for kvarn::prelude::Arc<T>where T: Ord + ?Sized,

1.10.0 · source§

impl<T> Ord for Cell<T>where T: Ord + Copy,

1.10.0 · source§

impl<T> Ord for RefCell<T>where T: Ord + ?Sized,

source§

impl<T> Ord for PhantomData<T>where T: ?Sized,

1.20.0 · source§

impl<T> Ord for ManuallyDrop<T>where T: Ord + ?Sized,

source§

impl<T> Ord for Saturating<T>where T: Ord,

source§

impl<T> Ord for Wrapping<T>where T: Ord,

1.25.0 · source§

impl<T> Ord for NonNull<T>where T: ?Sized,

source§

impl<T> Ord for LinkedList<T>where T: Ord,

source§

impl<T> Ord for Rc<T>where T: Ord + ?Sized,

source§

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

Available on __unicase__iter_cmp only.
source§

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

Available on __unicase__iter_cmp only.
1.19.0 · source§

impl<T> Ord for Reverse<T>where T: Ord,

§

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

§

impl<T> Ord for Arc<T>where T: Ord + ?Sized,

§

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

source§

impl<T, A> Ord for Box<T, A>where T: Ord + ?Sized, A: Allocator,

source§

impl<T, A> Ord for BTreeSet<T, A>where T: Ord, A: Allocator + Clone,

source§

impl<T, A> Ord for VecDeque<T, A>where T: Ord, A: Allocator,

source§

impl<T, A> Ord for Vec<T, A>where T: Ord, A: Allocator,

Implements ordering of vectors, lexicographically.

source§

impl<T, E> Ord for Result<T, E>where T: Ord, E: Ord,

§

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

source§

impl<T, const LANES: usize> Ord for Simd<T, LANES>where LaneCount<LANES>: SupportedLaneCount, T: SimdElement + Ord,

source§

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

Implements comparison of arrays lexicographically.

§

impl<T, const N: usize> Ord for TagNonNull<T, N>

§

impl<T, const N: usize> Ord for TagPtr<T, N>

source§

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

source§

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

source§

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

source§

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

source§

impl<Y, R> Ord for GeneratorState<Y, R>where Y: Ord, R: Ord,