smart_keymap::input

Struct PressedKey

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

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§

Source§

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

Source

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.

Source

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§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn eq(&self, other: &PressedKey<K, S>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<K: Key, S: PressedKeyState<K, Context = K::Context, Event = K::Event>> PressedKey for PressedKey<K, S>

Source§

type Context = <K as Key>::Context

The type of Context the pressed key handles.
Source§

type Event = <K as Key>::Event

The type of Event the pressed key handles.
Source§

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).
Source§

fn key_output(&self) -> KeyOutputState

Output for the pressed key.
Source§

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

Source§

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

Auto Trait Implementations§

§

impl<K, S> Freeze for PressedKey<K, S>
where K: Freeze, S: Freeze,

§

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

§

impl<K, S> Send for PressedKey<K, S>
where K: Send, S: Send,

§

impl<K, S> Sync for PressedKey<K, S>
where K: Sync, S: Sync,

§

impl<K, S> Unpin for PressedKey<K, S>
where K: Unpin, S: Unpin,

§

impl<K, S> UnwindSafe for PressedKey<K, S>
where K: UnwindSafe, S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.