Struct KeyInput 

#[non_exhaustive]
pub struct KeyInput {
    pub key: String,
    pub text: Option<String>,
    pub modifiers: Modifiers,
    pub action: KeyAction,
}

A key event in GPUI terms.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: String

GPUI’s key name, such as enter, left, f1 or a.

text: Option<String>

The text the key produces on the current layout, if any.

modifiers: Modifiers

Modifiers held.

action: KeyAction

Press, repeat or release.

Implementations

impl KeyInput

pub fn new(key: impl Into<String>) -> Self

A key press with no modifiers and no text.

pub fn with_text(self, text: impl Into<String>) -> Self

Set the produced text.

pub fn with_modifiers(self, modifiers: Modifiers) -> Self

Set the modifiers.

pub fn with_action(self, action: KeyAction) -> Self

Set the action.

Trait Implementations

impl Clone for KeyInput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyInput

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

Formats the value using the given formatter.

impl Default for KeyInput

fn default() -> Self

Returns the “default value” for a type.

impl Eq for KeyInput

impl PartialEq for KeyInput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyInput