Struct KeyEvent 

pub struct KeyEvent {
    pub code: KeyCode,
    pub modifiers: KeyModifiers,
    pub kind: KeyEventKind,
}

Keyboard input event.

Fields

code: KeyCode

The key code.

modifiers: KeyModifiers

Modifiers held down during the event.

kind: KeyEventKind

Whether this is a press, auto-repeat, or release.

Backends that cannot distinguish these always report KeyEventKind::Press. See KeyEventKind for per-backend behavior.

Implementations

impl KeyEvent

pub const fn new(code: KeyCode, modifiers: KeyModifiers) -> Self

Creates a key press event with the given code and modifiers.

pub const fn with_kind( code: KeyCode, modifiers: KeyModifiers, kind: KeyEventKind, ) -> Self

Creates a key event with an explicit KeyEventKind.

pub const fn is_down(self) -> bool

Returns true if this event is a press or auto-repeat (i.e. the key is down), and false for a release.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyEvent

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl Eq for KeyEvent

impl Hash for KeyEvent

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 KeyEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyEvent