Enum ModifierKey 

#[non_exhaustive]
pub enum ModifierKey {
    Shift,
    Control,
    Alt,
    Super,
}

A modifier key pressed as a standalone key event, independent of the KeyModifiers flags carried on non-modifier key events.

This is flat (no per-side variants) because side is conveyed separately: pair this with the surrounding KeyEvent’s KeyLocation::Left/KeyLocation::Right rather than duplicating left/right into ModifierKey itself.

Reporting a bare modifier press as a KeyCode::Modifier event is backend-dependent: the crossterm backend requires the terminal to support the kitty keyboard protocol with the REPORT_ALL_KEYS_AS_ESCAPE_CODES enhancement flag enabled; plain terminals never report these.

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.

Shift

Shift.

Control

Control.

Alt

Alt.

Super

Super/Meta (macOS Cmd, Windows/Super key).

Trait Implementations

impl Clone for ModifierKey

fn clone(&self) -> ModifierKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ModifierKey

impl Debug for ModifierKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModifierKey

fn deserialize<__D>( __deserializer: __D, ) -> Result<ModifierKey, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModifierKey

impl Hash for ModifierKey

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

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

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 StructuralPartialEq for ModifierKey