Enum KeyEventKind 

#[non_exhaustive]
pub enum KeyEventKind {
    Press,
    Repeat,
    Release,
}

Whether a key event is a press, an auto-repeat, or a release.

Not every backend can distinguish these. Plain terminals only ever emit Press. Backends with richer input report the full set:

• The winit/software backend emits Press, Repeat (winit’s repeat flag), and Release.
• The crossterm backend emits the full set only when the terminal supports the kitty keyboard protocol (kitty, WezTerm, foot, Ghostty, recent Alacritty); otherwise it degrades to Press-only.

Marked #[non_exhaustive] for consistency with sibling public enums, in case a future source reports a state finer-grained than this set (e.g. distinguishing an OS-level key-repeat from a backend-synthesized one).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Press

The key was pressed.

Repeat

The key is held and auto-repeating.

Release

The key was released.

Trait Implementations

impl Clone for KeyEventKind

fn clone(&self) -> KeyEventKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyEventKind

impl Debug for KeyEventKind

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

Formats the value using the given formatter.

impl Default for KeyEventKind

fn default() -> KeyEventKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyEventKind

fn deserialize<__D>( __deserializer: __D, ) -> Result<KeyEventKind, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyEventKind

impl Hash for KeyEventKind

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 KeyEventKind

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyEventKind