Enum termwiz::input::KeyCode

pub enum KeyCode {
    Char(char),
    Hyper,
    Super,
    Meta,
    Cancel,
    Backspace,
    Tab,
    Clear,
    Enter,
    Shift,
    Escape,
    LeftShift,
    RightShift,
    Control,
    LeftControl,
    RightControl,
    Alt,
    LeftAlt,
    RightAlt,
    Menu,
    LeftMenu,
    RightMenu,
    Pause,
    CapsLock,
    PageUp,
    PageDown,
    End,
    Home,
    LeftArrow,
    RightArrow,
    UpArrow,
    DownArrow,
    Select,
    Print,
    Execute,
    PrintScreen,
    Insert,
    Delete,
    Help,
    LeftWindows,
    RightWindows,
    Applications,
    Sleep,
    Numpad0,
    Numpad1,
    Numpad2,
    Numpad3,
    Numpad4,
    Numpad5,
    Numpad6,
    Numpad7,
    Numpad8,
    Numpad9,
    Multiply,
    Add,
    Separator,
    Subtract,
    Decimal,
    Divide,
    Function(u8),
    NumLock,
    ScrollLock,
    Copy,
    Cut,
    Paste,
    BrowserBack,
    BrowserForward,
    BrowserRefresh,
    BrowserStop,
    BrowserSearch,
    BrowserFavorites,
    BrowserHome,
    VolumeMute,
    VolumeDown,
    VolumeUp,
    MediaNextTrack,
    MediaPrevTrack,
    MediaStop,
    MediaPlayPause,
    ApplicationLeftArrow,
    ApplicationRightArrow,
    ApplicationUpArrow,
    ApplicationDownArrow,
    // some variants omitted
}

Which key is pressed. Not all of these are probable to appear on most systems. A lot of this list is @wez trawling docs and making an entry for things that might be possible in this first pass.

Variants

Char(char)

The decoded unicode character

Hyper

Super

Meta

Cancel

Ctrl-break on windows

Backspace

Tab

Clear

Enter

Shift

Escape

LeftShift

RightShift

Control

LeftControl

RightControl

Alt

LeftAlt

RightAlt

Menu

LeftMenu

RightMenu

Pause

CapsLock

PageUp

PageDown

End

Home

LeftArrow

RightArrow

UpArrow

DownArrow

Select

Print

Execute

PrintScreen

Insert

Delete

Help

LeftWindows

RightWindows

Applications

Sleep

Numpad0

Numpad1

Numpad2

Numpad3

Numpad4

Numpad5

Numpad6

Numpad7

Numpad8

Numpad9

Multiply

Add

Separator

Subtract

Decimal

Divide

Function(u8)

F1-F24 are possible

NumLock

ScrollLock

Copy

Cut

Paste

BrowserBack

BrowserForward

BrowserRefresh

BrowserStop

BrowserSearch

BrowserFavorites

BrowserHome

VolumeMute

VolumeDown

VolumeUp

MediaNextTrack

MediaPrevTrack

MediaStop

MediaPlayPause

ApplicationLeftArrow

ApplicationRightArrow

ApplicationUpArrow

ApplicationDownArrow

Implementations

impl KeyCode

pub fn normalize_shift_to_upper_case(self, modifiers: Modifiers) -> KeyCode

if SHIFT is held and we have KeyCode::Char(‘c’) we want to normalize that keycode to KeyCode::Char(‘C’); that is what this function does. In theory we should give the same treatment to keys like [ -> { but that assumes something about the keyboard layout and is probably better done in the gui frontend rather than this layer. In fact, this function might be better off if it lived elsewhere.

pub fn is_modifier(self) -> bool

Return true if the key represents a modifier key.

pub fn encode(
    &self,
    mods: Modifiers,
    modes: KeyCodeEncodeModes,
    is_down: bool
) -> Result<String>

Returns the byte sequence that represents this KeyCode and Modifier combination,

Trait Implementations

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyCode

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

Deserialize this value from the given Serde deserializer.

impl Hash for KeyCode

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<KeyCode> for KeyCode

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

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

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

This method tests for !=.

impl Serialize for KeyCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Copy for KeyCode

impl Eq for KeyCode

impl StructuralEq for KeyCode

impl StructuralPartialEq for KeyCode