Struct KeyInput 

pub struct KeyInput {
    pub key: KeyCode,
    pub modifiers: Modifiers,
}

A representation of a keyboard input.

Examples

Single key

use edtui::events::KeyInput;

let input = KeyInput::new('s');

Key with one modifier

use edtui::events::KeyInput;
use crossterm::event::KeyCode;

let input = KeyInput::ctrl(KeyCode::Esc);

Key with multiple modifiers

use edtui::events::KeyInput;
use crossterm::event::KeyModifiers;

let input = KeyInput::with_modifiers('k', KeyModifiers::CONTROL | KeyModifiers::SHIFT);

Fields

key: KeyCode

modifiers: Modifiers

Implementations

impl KeyInput

pub fn new<K: Into<KeyCode>>(key: K) -> Self

Create a key input without any modifiers.

pub fn ctrl<K: Into<KeyCode>>(key: K) -> Self

Create a key input with the ctrl modifier.

pub fn alt<K: Into<KeyCode>>(key: K) -> Self

Create a key input with the alt modifier.

pub fn shift<K: Into<KeyCode>>(key: K) -> Self

Create a key input with the shift modifier.

pub fn with_modifiers<K: Into<KeyCode>, M: Into<Modifiers>>( key: K, modifiers: M, ) -> Self

Create a key input with a set of modifiers. Supports shift, ctrl and alt.

pub fn normalize_altgr(self) -> Self

Normalize AltGr key events for international keyboard support.

Strips Ctrl+Alt modifiers from non-alphabetic characters, allowing symbols like [, ], {, }, \, @ to be typed on keyboards where these require AltGr (e.g., German, Swiss German).

Trait Implementations

impl Clone for KeyInput

fn clone(&self) -> KeyInput

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 From<KeyEvent> for KeyInput

fn from(ev: KeyEvent) -> Self

Converts to this type from the input type.

impl From<KeyEvent> for KeyInput

fn from(ev: KeyEvent) -> Self

Converts to this type from the input type.

impl Hash for KeyInput

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 KeyInput

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

impl Eq for KeyInput

impl StructuralPartialEq for KeyInput