Struct Keystroke 

pub struct Keystroke {
    pub modifiers: Modifiers,
    pub key: String,
    pub key_char: Option<String>,
}

A keystroke and associated metadata generated by the platform

Fields

modifiers: Modifiers

the state of the modifier keys at the time the keystroke was generated

key: String

key is the character printed on the key that was pressed e.g. for option-s, key is “s” On layouts that do not have ascii keys (e.g. Thai) this will be the ASCII-equivalent character (q instead of ๆ), and the typed character will be present in key_char.

key_char: Option<String>

key_char is the character that could have been typed when this binding was pressed. e.g. for s this is “s”, for option-s “ß”, and cmd-s None

Implementations

impl Keystroke

pub fn should_match(&self, target: &KeybindingKeystroke) -> bool

When matching a key we cannot know whether the user intended to type the key_char or the key itself. On some non-US keyboards keys we use in our bindings are behind option (for example $ is typed alt-ç on a Czech keyboard), and on some keyboards the IME handler converts a sequence of keys into a specific character (for example " is typed as " space on a brazilian keyboard).

This method assumes that self was typed and `target’ is in the keymap, and checks both possibilities for self against the target.

pub fn parse(source: &str) -> Result<Self, InvalidKeystrokeError>

key syntax is: [secondary-][ctrl-][alt-][shift-][cmd-][fn-]key[->key_char] key_char syntax is only used for generating test events, secondary means “cmd” on macOS and “ctrl” on other platforms when matching a key with an key_char set will be matched without it.

pub fn unparse(&self) -> String

Produces a representation of this key that Parse can understand.

pub fn is_ime_in_progress(&self) -> bool

Returns true if this keystroke left the ime system in an incomplete state.

pub fn with_simulated_ime(self) -> Self

Returns a new keystroke with the key_char filled. This is used for dispatch_keystroke where we want users to be able to simulate typing “space”, etc.

impl Keystroke

pub fn underlying_dead_key(keysym: Keysym) -> Option<String>

Returns which symbol the dead key represents https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values#dead_keycodes_for_linux

Trait Implementations

impl AsKeystroke for Keystroke

fn as_keystroke(&self) -> &Keystroke

Returns the GPUI representation of the keystroke.

impl Clone for Keystroke

fn clone(&self) -> Keystroke

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keystroke

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

Formats the value using the given formatter.

impl Default for Keystroke

fn default() -> Keystroke

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Keystroke

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Keystroke

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

Formats the value using the given formatter.

impl Hash for Keystroke

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

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

impl StructuralPartialEq for Keystroke