Enum crossterm::event::ModifierKeyCode

pub enum ModifierKeyCode {
    LeftShift,
    LeftControl,
    LeftAlt,
    LeftSuper,
    LeftHyper,
    LeftMeta,
    RightShift,
    RightControl,
    RightAlt,
    RightSuper,
    RightHyper,
    RightMeta,
    IsoLevel3Shift,
    IsoLevel5Shift,
}

Represents a modifier key (as part of KeyCode::Modifier).

Variants

LeftShift

Left Shift key.

LeftControl

Left Control key. (Control on macOS, Ctrl on other platforms)

LeftAlt

Left Alt key. (Option on macOS, Alt on other platforms)

LeftSuper

Left Super key. (Command on macOS, Windows on Windows, Super on other platforms)

LeftHyper

Left Hyper key.

LeftMeta

Left Meta key.

RightShift

Right Shift key.

RightControl

Right Control key. (Control on macOS, Ctrl on other platforms)

RightAlt

Right Alt key. (Option on macOS, Alt on other platforms)

RightSuper

Right Super key. (Command on macOS, Windows on Windows, Super on other platforms)

RightHyper

Right Hyper key.

RightMeta

Right Meta key.

IsoLevel3Shift

Iso Level3 Shift key.

IsoLevel5Shift

Iso Level5 Shift key.

Trait Implementations

impl Clone for ModifierKeyCode

fn clone(&self) -> ModifierKeyCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifierKeyCode

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

Formats the value using the given formatter.

impl Display for ModifierKeyCode

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

Formats the modifier key using the given formatter.

Platform-specific Notes

On macOS, the control, alt, and super keys are displayed as “Control”, “Option”, and “Command” respectively. See https://support.apple.com/guide/applestyleguide/welcome/1.0/web.

On Windows, the super key is displayed as “Windows” and the control key is displayed as “Ctrl”. See https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/keys-keyboard-shortcuts.

On other platforms, the super key is referred to as “Super”.

impl Hash for ModifierKeyCode

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<ModifierKeyCode> for ModifierKeyCode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ModifierKeyCode> for ModifierKeyCode

fn partial_cmp(&self, other: &ModifierKeyCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ModifierKeyCode

impl Eq for ModifierKeyCode

impl StructuralEq for ModifierKeyCode

impl StructuralPartialEq for ModifierKeyCode