Struct KeyCombination 

pub struct KeyCombination {
    pub codes: OneToThree<KeyCode>,
    pub modifiers: KeyModifiers,
}

A Key combination wraps from one to three standard keys with optional modifiers (ctrl, alt, shift).

Fields

codes: OneToThree<KeyCode>

modifiers: KeyModifiers

Implementations

impl KeyCombination

pub fn new<C>(codes: C, modifiers: KeyModifiers) -> KeyCombination

where C: Into<OneToThree<KeyCode>>,

Create a new KeyCombination from one to three keycodes and a set of modifiers

pub const fn one_key(code: KeyCode, modifiers: KeyModifiers) -> KeyCombination

Create a new KeyCombination from one keycode and a set of modifiers

pub const fn is_ansi_compatible(self) -> bool

Ansi terminals don’t manage key press/release/repeat, so they don’t allow to determine whether 2 keys are pressed at the same time. This means a combination involving several key codes can’t be distiguished from a sequences of combinations involving a single key code. For this reason, only combinations involving a single key code are considered “ansi compatible”

pub fn normalized(self) -> KeyCombination

Return a normailzed version of the combination.

Fix the case of the code to uppercase if the shift modifier is present. Add the SHIFT modifier if one code is uppercase.

This allows direct comparisons with the fields of crossterm::event::KeyEvent whose code is uppercase when the shift modifier is present. And supports the case where the modifier isn’t mentionned but the key is uppercase.

pub const fn as_letter(self) -> Option<char>

return the raw char if the combination is a letter event

Trait Implementations

impl Clone for KeyCombination

fn clone(&self) -> KeyCombination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCombination

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyCombination

Available on crate feature serde only.

fn deserialize<D>( deserializer: D, ) -> Result<KeyCombination, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KeyCombination

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

Formats the value using the given formatter.

impl From<KeyCode> for KeyCombination

fn from(key_code: KeyCode) -> KeyCombination

Converts to this type from the input type.

impl From<KeyCombination> for Trigger

fn from(key: KeyCombination) -> Self

Converts to this type from the input type.

impl From<KeyEvent> for KeyCombination

fn from(key_event: KeyEvent) -> KeyCombination

Converts to this type from the input type.

impl FromStr for KeyCombination

type Err = ParseKeyError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<KeyCombination, ParseKeyError>

Parses a string s to return a value of this type.

impl Hash for KeyCombination

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

where __H: Hasher,

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 Into<KeyEvent> for KeyCombination

fn into(self) -> KeyEvent

Converts this type into the (usually inferred) input type.

impl Ord for KeyCombination

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

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

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

Available on crate feature serde only.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[KeyEvent]> for KeyCombination

fn try_from( key_events: &[KeyEvent], ) -> Result<KeyCombination, <KeyCombination as TryFrom<&[KeyEvent]>>::Error>

Try to create a KeyCombination from a slice of key events, will fail if and only if the slice is empty.

type Error = &'static str

The type returned in the event of a conversion error.

impl Copy for KeyCombination

impl Eq for KeyCombination

impl StructuralPartialEq for KeyCombination