Expand description
Utilities for comparing and ordering values.
This module contains various tools for comparing and ordering values. Insummary:
PartialEq<Rhs>overloads the==and!=operators. In cases whereRhs(the right hand side’s type) isSelf, this trait corresponds to apartial equivalence relation.Eqindicates that the overloaded==operator corresponds to anequivalence relation.OrdandPartialOrdare traits that allow you to define total andpartial orderings between values, respectively. Implementing them overloadsthe<,<=,>, and>=operators.Orderingis an enum returned by the main functions ofOrdandPartialOrd, and describes an ordering of two values (less, equal, orgreater).Reverseis a struct that allows you to easily reverse an ordering.maxandminare functions that build off ofOrdand allow youto find the maximum or minimum of two values.
For more details, see the respective documentation of each item in the list.
Structs§
- Reverse
- A helper struct for reverse ordering.
Enums§
- Ordering
- An
Orderingis the result of a comparison between two values.
Traits§
- Eq
- Trait for comparisons corresponding toequivalence relations.
- Ord
- Trait for types that form atotal order.
- Partial
Eq - Trait for comparisons using the equality operator.
- Partial
Ord - Trait for types that form apartial order.
Functions§
- max
- Compares and returns the maximum of two values.
- max_by
- Returns the maximum of two values with respect to the specified comparison function.
- max_
by_ key - Returns the element that gives the maximum value from the specified function.
- min
- Compares and returns the minimum of two values.
- min_by
- Returns the minimum of two values with respect to the specified comparison function.
- min_
by_ key - Returns the element that gives the minimum value from the specified function.
- minmax
Experimental - Compares and sorts two values, returning minimum and maximum.
- minmax_
by Experimental - Returns minimum and maximum values with respect to the specified comparison function.
- minmax_
by_ key Experimental - Returns minimum and maximum values with respect to the specified key function.
Derive Macros§
- Eq
- Derive macro generating an impl of the trait
Eq. - Ord
- Derive macro generating an impl of the trait
Ord.The behavior of this macro is described in detailhere. - Partial
Eq - Derive macro generating an impl of the trait
PartialEq.The behavior of this macro is described in detailhere. - Partial
Ord - Derive macro generating an impl of the trait
PartialOrd.The behavior of this macro is described in detailhere.