Struct OrderKey 

pub struct OrderKey<'a> {
    pub group: Option<&'a str>,
    pub rank: i64,
    pub label: &'a str,
    pub identity: &'a str,
}

The four parts of the canonical order, most significant first. See the module documentation for what each part means and why the last one is not optional.

Fields

group: Option<&'a str>

The semantic bucket, or None for an item that is not filed under one. None sorts after every named group.

rank: i64

The explicit position inside the group, ascending. OrderKey::UNRANKED when the collection has no such semantics, which is most of them.

label: &'a str

What a person reads.

identity: &'a str

The canonical id: unique, and therefore the tie-breaker that makes the order total.

Implementations

impl<'a> OrderKey<'a>

pub const UNRANKED: i64 = 0

The rank of an item whose collection has no explicit ordering semantics. Zero, so that a collection where only some items are ranked puts those first, which is what an explicit rank is for.

pub fn plain(label: &'a str, identity: &'a str) -> Self

An item with no group and no explicit rank: ordered by its label, then its identity.

pub fn grouped(group: &'a str, label: &'a str, identity: &'a str) -> Self

An item filed under a group, ordered inside it by its label, then its identity.

pub fn ranked(self, rank: i64) -> Self

The same key with an explicit position inside its group.

Trait Implementations

impl<'a> Clone for OrderKey<'a>

fn clone(&self) -> OrderKey<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for OrderKey<'a>

impl<'a> Debug for OrderKey<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Eq for OrderKey<'a>

impl Ord for OrderKey<'_>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for OrderKey<'a>

fn eq(&self, other: &OrderKey<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for OrderKey<'_>

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralPartialEq for OrderKey<'a>