Enum wezterm_input_types::KeyCode

pub enum KeyCode {
    Char(char),
    Composed(String),
    RawCode(u32),
    Physical(PhysKeyCode),
    Hyper,
    Super,
    Meta,
    Cancel,
    Clear,
    Shift,
    LeftShift,
    RightShift,
    Control,
    LeftControl,
    RightControl,
    Alt,
    LeftAlt,
    RightAlt,
    Pause,
    CapsLock,
    VoidSymbol,
    PageUp,
    PageDown,
    End,
    Home,
    LeftArrow,
    RightArrow,
    UpArrow,
    DownArrow,
    Select,
    Print,
    Execute,
    PrintScreen,
    Insert,
    Help,
    LeftWindows,
    RightWindows,
    Applications,
    Sleep,
    Numpad(u8),
    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,
    KeyPadHome,
    KeyPadEnd,
    KeyPadPageUp,
    KeyPadPageDown,
    KeyPadBegin,
}

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

Composed(String)

RawCode(u32)

Physical(PhysKeyCode)

Hyper

Super

Meta

Cancel

Ctrl-break on windows

Clear

Shift

LeftShift

RightShift

Control

LeftControl

RightControl

Alt

LeftAlt

RightAlt

Pause

CapsLock

VoidSymbol

PageUp

PageDown

End

Home

LeftArrow

RightArrow

UpArrow

DownArrow

Select

Print

Execute

PrintScreen

Insert

Help

LeftWindows

RightWindows

Applications

Sleep

Numpad(u8)

Numeric keypad digits 0-9

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

KeyPadHome

KeyPadEnd

KeyPadPageUp

KeyPadPageDown

KeyPadBegin

Implementations

impl KeyCode

pub fn is_modifier(&self) -> bool

Return true if the key represents a modifier key.

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

pub fn composed(s: &str) -> Self

pub fn to_phys(&self) -> Option<PhysKeyCode>

Convert to a PhysKeyCode. Note that by the nature of PhysKeyCode being defined in terms of a US ANSI standard layout, essentially “latinizes” the keycode, so the results may not make as much sense for non-latin keyboards. It also loses the shifted state of alphabetical characters.

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 FromDynamic for KeyCode

fn from_dynamic( value: &Value, options: FromDynamicOptions ) -> Result<Self, Error>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for KeyCode

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

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

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

impl PartialOrd for KeyCode

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

fn to_dynamic(&self) -> Value

impl ToString for KeyCode

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<&str> for KeyCode

type Error = String

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, String>

Performs the conversion.

impl Eq for KeyCode

impl StructuralEq for KeyCode

impl StructuralPartialEq for KeyCode