Struct KeyChord 

pub struct KeyChord {
    pub key: Key,
    pub mods: Modifiers,
}

A key plus modifiers.

Fields

key: Key

The key.

mods: Modifiers

The modifiers held with it.

Implementations

impl KeyChord

pub fn plain(key: Key) -> Self

A chord without modifiers.

pub fn label(&self) -> String

Short label for key hint bars: ctrl p, shift tab, ?, f12.

Trait Implementations

impl Clone for KeyChord

fn clone(&self) -> KeyChord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyChord

impl Debug for KeyChord

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

Formats the value using the given formatter.

impl Display for KeyChord

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

The canonical form used in keymap files: ctrl+shift+p.

impl Eq for KeyChord

impl FromStr for KeyChord

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses ctrl+shift+p, ?, f12, shift+tab. Modifier and key names are case-insensitive, but an uppercase letter means shift plus that letter: S is shift+s, as a terminal reports it. + alone is the plus key.

type Err = String

The associated error which can be returned from parsing.

impl Hash for KeyChord

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 KeyChord

fn cmp(&self, other: &KeyChord) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for KeyChord

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for KeyChord

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