Enum Caret 

#[non_exhaustive]
pub enum Caret {
    Sorted(Sort),
    Idle,
    None,
}

The mark a column’s heading carries, and so the tone it is drawn in.

Three states with a mark and one without (wiki three-tone-convention): the column in force, in its direction; a column that offers to be ordered and is not; and a column that is not a control at all. The idle mark spells as Sort::Ascending, the direction a first press takes, so pressing a heading never changes its width.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sorted(Sort)

The table is ordered by this column, this way.

Idle

The column offers to order the table and is not doing it now.

None

No mark: the column neither orders the table nor offers to.

Implementations

impl Caret

pub const fn of(sorted: Option<Sort>, caret: bool) -> Self

The caret for a column ordered by sorted, with ColumnRoom::caret saying whether a caret sits beside its heading.

A column sorted but not sortable still carries its direction: a list ordered by a key the user cannot change is a real thing, and the caret is how it says so.

pub fn label(self, name: &str, ascending: &str, descending: &str) -> String

The heading as every host writes it: name in capitals, then a space and the glyph this caret spells, ascending or descending.

Trait Implementations

impl Clone for Caret

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Caret

impl Debug for Caret

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

Formats the value using the given formatter.

impl Eq for Caret

impl Hash for Caret

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 PartialEq for Caret

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Caret