Struct KeyEvents

pub struct KeyEvents<E, const M: usize = { MAX_KEY_EVENTS }>(/* private fields */);

Events emitted when a Key is pressed.

Implementations

impl<E: Copy + Debug> KeyEvents<E>

pub fn no_events() -> Self

Constructs a KeyEvents with no events scheduled.

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

Constructs a KeyEvents with an immediate Event.

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

Constructs a KeyEvents with an Event scheduled after a delay.

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

Adds an event with the schedule to the KeyEvents.

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

Adds events from the other KeyEvents to the KeyEvents.

pub fn add_event(&mut self, ev: ScheduledEvent<E>)

Adds an event from 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: Debug, const M: usize> Debug for KeyEvents<E, M>

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

Formats the value using the given formatter.

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

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) -> Self::IntoIter

Creates an iterator from a value.

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

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: Eq, const M: usize> Eq for KeyEvents<E, M>

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