Struct KeyboardDetail 

#[non_exhaustive]
pub struct KeyboardDetail {
    pub key: String,
    pub modifiers: KeyboardModifiers,
    pub repeat: bool,
}

keydown / keypress / keyup payload.

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

DOM KeyboardEvent.key — the printable character or named key value ("Enter", "ArrowLeft", "a", "F5", …). Translation from crossterm::KeyCode lives in rdom-tui::tui_event::key_translate (M4a step 7).

modifiers: KeyboardModifiers

Modifiers held during the press.

repeat: bool

true for OS-generated repeats of a held key.

Implementations

impl KeyboardDetail

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

A key payload (KeyboardEventInit) for key with modifiers, not a repeat.

pub fn with_repeat(self, repeat: bool) -> Self

Set repeat (an OS-generated repeat of a held key).

Trait Implementations

impl Clone for KeyboardDetail

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 KeyboardDetail

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

Formats the value using the given formatter.

impl Eq for KeyboardDetail

impl Hash for KeyboardDetail

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 KeyboardDetail

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyboardDetail