Trait kvarn::prelude::Ord

1.0.0 · source ·
pub trait Ord: Eq + PartialOrd {
    // 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 { ... }
}
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.

Violating these requirements is a logic error. The behavior resulting from a logic error is not specified, but users of the trait must ensure that such logic errors do not result in undefined behavior. This means that unsafe code must not rely on the correctness of these methods.

§Corollaries

From the above and the requirements of PartialOrd, it follows 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 >.

Mathematically speaking, the < operator defines a strict weak order. In cases where == conforms to mathematical equality, it also defines a strict total order.

§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 primarily by their discriminants. Secondarily, they are ordered by their fields. 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 sequences 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§

1.0.0 · 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) -> Self
where 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!(1.max(2), 2);
assert_eq!(2.max(2), 2);
1.21.0 · source

fn min(self, other: Self) -> Self
where 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.min(2), 1);
assert_eq!(2.min(2), 2);
1.50.0 · source

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

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_eq!((-3).clamp(-2, 1), -2);
assert_eq!(0.clamp(-2, 1), 0);
assert_eq!(2.clamp(-2, 1), 1);

Object Safety§

This trait is not object safe.

Implementors§

source§

impl Ord for Action

1.7.0 · source§

impl Ord for IpAddr

1.0.0 · source§

impl Ord for SocketAddr

source§

impl Ord for log::Level

source§

impl Ord for log::LevelFilter

source§

impl Ord for Direction

source§

impl Ord for RequestParseStage

source§

impl Ord for AsciiChar

1.0.0 · source§

impl Ord for Ordering

1.34.0 · source§

impl Ord for Infallible

1.0.0 · source§

impl Ord for ErrorKind

1.0.0 · source§

impl Ord for bool

1.0.0 · source§

impl Ord for char

1.0.0 · source§

impl Ord for i8

1.0.0 · source§

impl Ord for i16

1.0.0 · source§

impl Ord for i32

1.0.0 · source§

impl Ord for i64

1.0.0 · source§

impl Ord for i128

1.0.0 · source§

impl Ord for isize

source§

impl Ord for !

1.0.0 · 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.

1.0.0 · source§

impl Ord for u8

1.0.0 · source§

impl Ord for u16

1.0.0 · source§

impl Ord for u32

1.0.0 · source§

impl Ord for u64

1.0.0 · source§

impl Ord for u128

1.0.0 · source§

impl Ord for ()

1.0.0 · source§

impl Ord for usize

source§

impl Ord for Id

§

impl Ord for OffsetDateTime

1.64.0 · source§

impl Ord for CString

1.0.0 · source§

impl Ord for String

1.0.0 · source§

impl Ord for OsStr

1.0.0 · source§

impl Ord for OsString

1.0.0 · source§

impl Ord for Components<'_>

1.0.0 · source§

impl Ord for PrefixComponent<'_>

1.8.0 · source§

impl Ord for SystemTime

source§

impl Ord for FixedBitSet

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

source§

impl Ord for Mime

§

impl Ord for Bytes

§

impl Ord for BytesMut

§

impl Ord for CompactString

1.3.0 · source§

impl Ord for kvarn::prelude::Duration

§

impl Ord for HeaderValue

1.8.0 · source§

impl Ord for kvarn::prelude::Instant

1.0.0 · source§

impl Ord for Path

1.0.0 · source§

impl Ord for PathBuf

§

impl Ord for StatusCode

§

impl Ord for Version

1.0.0 · source§

impl Ord for TypeId

1.27.0 · source§

impl Ord for CpuidResult

1.0.0 · source§

impl Ord for CStr

1.33.0 · source§

impl Ord for PhantomPinned

source§

impl Ord for Alignment

1.0.0 · source§

impl Ord for Error

1.0.0 · source§

impl Ord for Ipv4Addr

1.0.0 · source§

impl Ord for Ipv6Addr

1.0.0 · source§

impl Ord for SocketAddrV4

1.0.0 · source§

impl Ord for SocketAddrV6

§

impl Ord for AnyDelimiterCodec

§

impl Ord for BigEndian

§

impl Ord for BytesCodec

§

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

§

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 TagPropagation

§

impl Ord for Time

§

impl Ord for TimeoutFlags

§

impl Ord for Token

§

impl Ord for UtcOffset

§

impl Ord for VarInt

§

impl Ord for WatchDescriptor

§

impl Ord for WatchMask

§

impl Ord for WriteError

1.0.0 · source§

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

1.0.0 · source§

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

source§

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

source§

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

source§

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

1.10.0 · source§

impl<'a> Ord for Location<'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,

1.0.0 · source§

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

1.0.0 · source§

impl<A> Ord for &mut A
where 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,

1.0.0 · source§

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

source§

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

1.4.0 · source§

impl<F> Ord for F
where F: FnPtr,

§

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

§

impl<H, T> Ord for HeaderSlice<HeaderWithLength<H>, T>
where H: Ord, T: Ord + ?Sized,

§

impl<H, T> Ord for ThinArc<H, T>
where H: Ord, T: Ord,

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,

§

impl<K, V> Ord for Slice<K, V>
where K: Ord, V: Ord,

1.0.0 · source§

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

1.41.0 · source§

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

§

impl<Storage> Ord for __BindgenBitfieldUnit<Storage>
where Storage: Ord,

1.36.0 · source§

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

1.0.0 · source§

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

1.0.0 · source§

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

1.0.0 · source§

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

1.0.0 · source§

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

Implements comparison of slices lexicographically.

1.0.0 · 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 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.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,

1.19.0 · source§

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

1.0.0 · source§

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

1.20.0 · source§

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

1.28.0 · source§

impl<T> Ord for NonZero<T>

1.74.0 · source§

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

1.0.0 · source§

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

1.25.0 · source§

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

§

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,

§

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

1.0.0 · source§

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

1.0.0 · source§

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

1.0.0 · source§

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

1.0.0 · source§

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

1.0.0 · source§

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

1.0.0 · source§

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

Implements ordering of vectors, lexicographically.

1.0.0 · source§

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

1.0.0 · 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>,

1.0.0 · source§

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

Implements comparison of arrays lexicographically.

source§

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

§

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 CoroutineState<Y, R>
where Y: Ord, R: Ord,

§

impl<const MIN: i8, const MAX: i8> Ord for OptionRangedI8<MIN, MAX>

§

impl<const MIN: i8, const MAX: i8> Ord for RangedI8<MIN, MAX>

§

impl<const MIN: i16, const MAX: i16> Ord for OptionRangedI16<MIN, MAX>

§

impl<const MIN: i16, const MAX: i16> Ord for RangedI16<MIN, MAX>

§

impl<const MIN: i32, const MAX: i32> Ord for OptionRangedI32<MIN, MAX>

§

impl<const MIN: i32, const MAX: i32> Ord for RangedI32<MIN, MAX>

§

impl<const MIN: i64, const MAX: i64> Ord for OptionRangedI64<MIN, MAX>

§

impl<const MIN: i64, const MAX: i64> Ord for RangedI64<MIN, MAX>

§

impl<const MIN: i128, const MAX: i128> Ord for OptionRangedI128<MIN, MAX>

§

impl<const MIN: i128, const MAX: i128> Ord for RangedI128<MIN, MAX>

§

impl<const MIN: isize, const MAX: isize> Ord for OptionRangedIsize<MIN, MAX>

§

impl<const MIN: isize, const MAX: isize> Ord for RangedIsize<MIN, MAX>

§

impl<const MIN: u8, const MAX: u8> Ord for OptionRangedU8<MIN, MAX>

§

impl<const MIN: u8, const MAX: u8> Ord for RangedU8<MIN, MAX>

§

impl<const MIN: u16, const MAX: u16> Ord for OptionRangedU16<MIN, MAX>

§

impl<const MIN: u16, const MAX: u16> Ord for RangedU16<MIN, MAX>

§

impl<const MIN: u32, const MAX: u32> Ord for OptionRangedU32<MIN, MAX>

§

impl<const MIN: u32, const MAX: u32> Ord for RangedU32<MIN, MAX>

§

impl<const MIN: u64, const MAX: u64> Ord for OptionRangedU64<MIN, MAX>

§

impl<const MIN: u64, const MAX: u64> Ord for RangedU64<MIN, MAX>

§

impl<const MIN: u128, const MAX: u128> Ord for OptionRangedU128<MIN, MAX>

§

impl<const MIN: u128, const MAX: u128> Ord for RangedU128<MIN, MAX>

§

impl<const MIN: usize, const MAX: usize> Ord for OptionRangedUsize<MIN, MAX>

§

impl<const MIN: usize, const MAX: usize> Ord for RangedUsize<MIN, MAX>

§

impl<const SIZE: usize> Ord for WriteBuffer<SIZE>