Trait sp_std::cmp::PartialOrd

1.0.0 · source · [−]

pub trait PartialOrd<Rhs = Self>: PartialEq<Rhs> where
    Rhs: ?Sized, {
    fn partial_cmp(&self, other: &Rhs) -> Option<Ordering>;

    fn lt(&self, other: &Rhs) -> bool { ... }
    fn le(&self, other: &Rhs) -> bool { ... }
    fn gt(&self, other: &Rhs) -> bool { ... }
    fn ge(&self, other: &Rhs) -> bool { ... }
}

Expand description

Trait for types that form a partial order.

The lt, le, gt, and ge methods of this trait can be called using the <, <=, >, and >= operators, respectively.

The methods of this trait must be consistent with each other and with those of PartialEq in the following sense:

a == b if and only if partial_cmp(a, b) == Some(Equal).
a < b if and only if partial_cmp(a, b) == Some(Less) (ensured by the default implementation).
a > b if and only if partial_cmp(a, b) == Some(Greater) (ensured by the default implementation).
a <= b if and only if a < b || a == b (ensured by the default implementation).
a >= b if and only if a > b || a == b (ensured by the default implementation).
a != b if and only if !(a == b) (already part of PartialEq).

If Ord is also implemented for Self and Rhs, it must also be consistent with partial_cmp (see the documentation of that trait for the exact requirements). It’s easy to accidentally make them disagree by deriving some of the traits and manually implementing others.

The comparison must satisfy, for all a, b and c:

transitivity: a < b and b < c implies a < c. The same must hold for both == and >.
duality: a < b if and only if b > a.

Note that these requirements mean that the trait itself must be implemented symmetrically and transitively: if T: PartialOrd and U: PartialOrd<V> then U: PartialOrd<T> and T: PartialOrd<V>.

Corollaries

The following corollaries follow from the above requirements:

irreflexivity of < and >: !(a < a), !(a > a)
transitivity of >: if a > b and b > c then a > c
duality of partial_cmp: partial_cmp(a, b) == partial_cmp(b, a).map(Ordering::reverse)

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, PartialOrd)]
enum E {
    Top,
    Bottom,
}

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

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

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

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

How can I implement `PartialOrd`?

PartialOrd only requires implementation of the partial_cmp method, with the others generated from default implementations.

However it remains possible to implement the others separately for types which do not have a total order. For example, for floating point numbers, NaN < 0 == false and NaN >= 0 == false (cf. IEEE 754-2008 section 5.11).

PartialOrd requires your type to be PartialEq.

If your type is Ord, you can implement partial_cmp by using cmp:

use std::cmp::Ordering;

#[derive(Eq)]
struct Person {
    id: u32,
    name: String,
    height: u32,
}

impl PartialOrd for Person {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for Person {
    fn cmp(&self, other: &Self) -> Ordering {
        self.height.cmp(&other.height)
    }
}

impl PartialEq for Person {
    fn eq(&self, other: &Self) -> bool {
        self.height == other.height
    }
}

You may also find it useful to use partial_cmp on your type’s fields. Here is an example of Person types who have a floating-point height field that is the only field to be used for sorting:

use std::cmp::Ordering;

struct Person {
    id: u32,
    name: String,
    height: f64,
}

impl PartialOrd for Person {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.height.partial_cmp(&other.height)
    }
}

impl PartialEq for Person {
    fn eq(&self, other: &Self) -> bool {
        self.height == other.height
    }
}

Examples

let x: u32 = 0;
let y: u32 = 1;

assert_eq!(x < y, true);
assert_eq!(x.lt(&y), true);

Trait sp_std::cmp::PartialOrd

Required methods

fn partial_cmp(&self, other: &Rhs) -> Option<Ordering>

Provided methods

fn lt(&self, other: &Rhs) -> bool

fn le(&self, other: &Rhs) -> bool

fn gt(&self, other: &Rhs) -> bool

fn ge(&self, other: &Rhs) -> bool

Implementations on Foreign Types

impl<'a, 'b> PartialOrd<OsString> for OsStr

pub fn partial_cmp(&self, other: &OsString) -> Option<Ordering>

impl<'a, 'b> PartialOrd<&'a OsStr> for OsString

pub fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<PathBuf> for &'a Path

pub fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>

impl<'a, 'b> PartialOrd<PathBuf> for OsStr

pub fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>

impl PartialOrd<Ipv4Addr> for IpAddr

pub fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>

impl PartialOrd<Ipv6Addr> for Ipv6Addr

pub fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>

impl PartialOrd<IpAddr> for Ipv4Addr

pub fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<PathBuf> for &'a OsStr

pub fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>

impl<'a, 'b> PartialOrd<OsString> for PathBuf

pub fn partial_cmp(&self, other: &OsString) -> Option<Ordering>

impl PartialOrd<IpAddr> for IpAddr

pub fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Path> for OsString

pub fn partial_cmp(&self, other: &Path) -> Option<Ordering>

impl<'a, 'b> PartialOrd<OsString> for &'a Path

pub fn partial_cmp(&self, other: &OsString) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Path> for PathBuf

pub fn partial_cmp(&self, other: &Path) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for Path

pub fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>

impl PartialOrd<CStr> for CStr

pub fn partial_cmp(&self, other: &CStr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for OsStr

pub fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>

impl<'a, 'b> PartialOrd<&'a Path> for OsStr

pub fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>

impl PartialOrd<ErrorKind> for ErrorKind

pub fn partial_cmp(&self, other: &ErrorKind) -> Option<Ordering>

impl<'a, 'b> PartialOrd<OsString> for &'a OsStr

pub fn partial_cmp(&self, other: &OsString) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for OsStr

pub fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>

impl PartialOrd<Ipv6Addr> for IpAddr

pub fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>

impl<'a> PartialOrd<PrefixComponent<'a>> for PrefixComponent<'a>

pub fn partial_cmp(&self, other: &PrefixComponent<'a>) -> Option<Ordering>

impl<'a, 'b> PartialOrd<&'a Path> for OsString

pub fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>

impl<'a> PartialOrd<Component<'a>> for Component<'a>

pub fn partial_cmp(&self, other: &Component<'a>) -> Option<Ordering>

impl PartialOrd<OsString> for OsString

pub fn partial_cmp(&self, other: &OsString) -> Option<Ordering>

pub fn lt(&self, other: &OsString) -> bool

pub fn le(&self, other: &OsString) -> bool

pub fn gt(&self, other: &OsString) -> bool

pub fn ge(&self, other: &OsString) -> bool

impl<'a, 'b> PartialOrd<Path> for OsStr

pub fn partial_cmp(&self, other: &Path) -> Option<Ordering>

impl<'a> PartialOrd<Prefix<'a>> for Prefix<'a>

pub fn partial_cmp(&self, other: &Prefix<'a>) -> Option<Ordering>

impl PartialOrd<PathBuf> for PathBuf

pub fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>

impl PartialOrd<IpAddr> for Ipv6Addr

pub fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>

impl<'a, 'b> PartialOrd<&'a Path> for PathBuf

pub fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>

impl PartialOrd<str> for OsStr

pub fn partial_cmp(&self, other: &str) -> Option<Ordering>

impl PartialOrd<SocketAddrV4> for SocketAddrV4

pub fn partial_cmp(&self, other: &SocketAddrV4) -> Option<Ordering>

impl<'a, 'b> PartialOrd<PathBuf> for OsString

pub fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>

impl<'a, 'b> PartialOrd<Path> for &'a OsStr