Enum Sort 

pub enum Sort {
    Desc,
    Asc,
    Unsorted,
}

Sort order by count.

Examples

use word_tally::Sort;

assert_eq!(Sort::default(), Sort::Desc);
assert_eq!(Sort::Desc.to_string(), "desc");
assert_eq!(Sort::Asc.to_string(), "asc");
assert_eq!(Sort::Unsorted.to_string(), "unsorted");

Variants

Desc

Sort by count descending.

Asc

Sort by count ascending.

Unsorted

No sorting applied.

Implementations

impl Sort

pub const fn should_sort(&self) -> bool

Returns true if sorting should be applied.

pub const fn is_descending(&self) -> bool

Returns true if sorting should be in descending order.

pub fn apply(&self, tally: &mut [(Word, Count)], io: Io)

Sorts the tally in place based on the sort order and I/O mode.

Trait Implementations

impl Clone for Sort

fn clone(&self) -> Sort

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sort

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

Formats the value using the given formatter.

impl Default for Sort

fn default() -> Sort

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sort

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Sort

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

Formats the value using the given formatter.

impl Hash for Sort

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Sort

fn cmp(&self, other: &Sort) -> 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 PartialEq for Sort

fn eq(&self, other: &Sort) -> 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 Sort

fn partial_cmp(&self, other: &Sort) -> 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 Serialize for Sort

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValueEnum for Sort

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Copy for Sort

impl Eq for Sort

impl StructuralPartialEq for Sort