Struct KeyState 

pub struct KeyState { /* private fields */ }

Tracks which keys are currently held down.

Feed it every KeyEvent (or Event) you receive and query is_held each frame for held-key movement. A key is considered held from its first KeyEventKind::Press until a matching KeyEventKind::Release.

Held keys are keyed by (KeyCode, KeyLocation), so a held Numpad8 and a held digit-row 8 are tracked separately: is_held takes the pair, and held yields it.

This is only useful on backends that emit release events (winit, or a terminal with the kitty keyboard protocol). On press-only backends a key never leaves the held set on its own, so call clear at a suitable boundary (e.g. once per turn) if you rely on it there.

Implementations

impl KeyState

pub const fn new() -> Self

Creates an empty key-state tracker.

pub fn apply(&mut self, event: KeyEvent)

Updates the held set from a key event.

Press and Repeat add the (code, location) pair; Release removes it.

pub fn apply_event(&mut self, event: &Event)

Updates the held set from an Event, ignoring non-key events.

pub fn is_held(&self, code: KeyCode, location: KeyLocation) -> bool

Returns true if code at location is currently held.

pub fn held(&self) -> impl Iterator<Item = (KeyCode, KeyLocation)> + '_

Iterates the currently held (code, location) pairs, in first-pressed order.

pub fn clear(&mut self)

Clears all held keys.

Trait Implementations

impl Clone for KeyState

fn clone(&self) -> KeyState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyState

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

Formats the value using the given formatter.

impl Default for KeyState

fn default() -> KeyState

Returns the “default value” for a type.