Struct KeyEvents 

pub struct KeyEvents<E, const M: usize = smart_keymap_core::::key::KeyEvents::{constant#0}>(/* private fields */);

Events emitted when a key is pressed.

Implementations

impl<E> KeyEvents<E>

where E: Copy + Debug,

pub fn no_events() -> KeyEvents<E>

Constructs a KeyEvents with no events scheduled.

pub fn event(event: Event<E>) -> KeyEvents<E>

Constructs a KeyEvents with one same-turn Event.

Prefer this for effects that should run in the current turn (via the event scheduler’s pending queue). For delayed effects, use Self::schedule_event or Self::scheduled_event with ScheduledEvent::after.

This is not the physical input delay line (InputEventQueue one-per-tick pacing).

pub fn scheduled_event(sch_event: ScheduledEvent<E>) -> KeyEvents<E>

Constructs a KeyEvents from a single ScheduledEvent (typically ScheduledEvent::after).

pub fn add_event(&mut self, event: Event<E>)

Appends a same-turn Event (see Self::event).

pub fn schedule_event(&mut self, delay: u16, event: Event<E>)

Appends an Event scheduled after delay ticks/ms units (promoted on Keymap::tick, not same-turn).

pub fn extend(&mut self, other: KeyEvents<E>)

Adds events from the other KeyEvents to the KeyEvents.

pub fn map_events<F>(&self, f: fn(E) -> F) -> KeyEvents<F>

Maps over the KeyEvents.

pub fn into_events<F>(&self) -> KeyEvents<F>

where E: Into<F>,

Maps the KeyEvents to a new type.

Trait Implementations

impl<E, const M: usize> Debug for KeyEvents<E, M>

where E: Debug,

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

Formats the value using the given formatter.

impl<E, const M: usize> IntoIterator for KeyEvents<E, M>

where E: Debug,

type Item = ScheduledEvent<E>

The type of the elements being iterated over.

type IntoIter = <Vec<ScheduledEvent<E>, M> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <KeyEvents<E, M> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<E, const M: usize> PartialEq for KeyEvents<E, M>

where E: PartialEq,

fn eq(&self, other: &KeyEvents<E, M>) -> 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<E, const M: usize> Eq for KeyEvents<E, M>

where E: Eq,

impl<E, const M: usize> StructuralPartialEq for KeyEvents<E, M>