Struct PressedKey

pub struct PressedKey<K, S> {
    pub keymap_index: u16,
    pub key: K,
    pub pressed_key_state: S,
}

A struct for associating a crate::key::Key with a crate::key::PressedKeyState.

Fields

keymap_index: u16

The index of the pressed key in some keymap.

key: K

The pressed key.

pressed_key_state: S

The pressed key state.

Implementations

impl<K, S> PressedKey<K, S>

pub fn map_pressed_key<IK, IS>( self, f_k: fn(_: K) -> IK, f_s: fn(_: S) -> IS, ) -> PressedKey<IK, IS>

Maps the key and pressed key state of the PressedKey to a new type.

pub fn into_pressed_key<IK, IS>(self) -> PressedKey<IK, IS>

where K: Into<IK>, S: Into<IS>,

Transforms the PressedKey to a new type.

Trait Implementations

impl<K: Clone, S: Clone> Clone for PressedKey<K, S>

fn clone(&self) -> PressedKey<K, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, S: Debug> Debug for PressedKey<K, S>

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

Formats the value using the given formatter.

impl<K: PartialEq, S: PartialEq> PartialEq for PressedKey<K, S>

fn eq(&self, other: &PressedKey<K, S>) -> 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<K: Key, S: PressedKeyState<K, Context = K::Context, Event = K::Event>> PressedKey for PressedKey<K, S>

type Context = <K as Key>::Context

The type of Context the pressed key handles.

type Event = <K as Key>::Event

The type of Event the pressed key handles.

fn handle_event( &mut self, context: Self::Context, event: Event<Self::Event>, ) -> PressedKeyEvents<Self::Event>

Used to update the PressedKey’s state, and possibly yield event(s).

fn key_output(&self) -> KeyOutputState

Output for the pressed key.

impl<K: Copy, S: Copy> Copy for PressedKey<K, S>

impl<K, S> StructuralPartialEq for PressedKey<K, S>