Module sp_std::cmp

Functionality for ordering and comparison.

This module contains various tools for ordering and comparing values. In summary:

• Eq and PartialEq are traits that allow you to define total and partial equality between values, respectively. Implementing them overloads the == and != operators.
• Ord and PartialOrd are traits that allow you to define total and partial orderings between values, respectively. Implementing them overloads the <, <=, >, and >= operators.
• Ordering is an enum returned by the main functions of Ord and PartialOrd, and describes an ordering.
• Reverse is a struct that allows you to easily reverse an ordering.
• max and min are functions that build off of Ord and allow you to find the maximum or minimum of two values.

For more details, see the respective documentation of each item in the list.

Macros

Eq	Derive macro generating an impl of the trait Eq.
Ord	Derive macro generating an impl of the trait Ord.
PartialEq	Derive macro generating an impl of the trait PartialEq.
PartialOrd	Derive macro generating an impl of the trait PartialOrd.

Structs

Reverse

A helper struct for reverse ordering.

Enums

Ordering

An Ordering is the result of a comparison between two values.

Traits

Eq	Trait for equality comparisons which are equivalence relations.
Ord	Trait for types that form a total order.
PartialEq	Trait for equality comparisons which are partial equivalence relations.
PartialOrd	Trait for values that can be compared for a sort-order.

Functions

max_by	Experimental Returns the maximum of two values with respect to the specified comparison function.
max_by_key	Experimental Returns the element that gives the maximum value from the specified function.
min_by	Experimental Returns the minimum of two values with respect to the specified comparison function.
min_by_key	Experimental Returns the element that gives the minimum value from the specified function.
max	Compares and returns the maximum of two values.
min	Compares and returns the minimum of two values.