smart_keymap::key::chorded

Enum PressedKeyState

Source
pub enum PressedKeyState<K: Key> {
    Pending {
        pressed_indices: Vec<u16, { MAX_CHORD_SIZE }>,
        satisfaction: ChordSatisfaction,
    },
    Resolved(ChordResolution<K::PressedKey>),
}
Expand description

State for pressed keys.

Variants§

§

Pending

Waiting for more Events

Fields

§pressed_indices: Vec<u16, { MAX_CHORD_SIZE }>

The keymap indices which have been pressed.

§satisfaction: ChordSatisfaction

Whether the chord has been satisfied.

§

Resolved(ChordResolution<K::PressedKey>)

Chord resolved from Events

Implementations§

Source§

impl<K: Key> PressedKeyState<K>

Source

pub fn new(context: K::Context, keymap_index: u16) -> Self

Constructs a new PressedKeyState.

Source

pub fn handle_event_for<C: ChordedKey<K>>( &mut self, context: K::Context, keymap_index: u16, key: &C, event: Event<K::Event>, ) -> PressedKeyEvents<K::Event>

Handle PKS for primary chorded key.

Source

pub fn key_output(&self) -> KeyOutputState

Key output from the pressed key state.

Trait Implementations§

Source§

impl<K: Debug + Key> Debug for PressedKeyState<K>
where K::PressedKey: Debug,

Source§

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

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

impl<K: PartialEq + Key> PartialEq for PressedKeyState<K>

Source§

fn eq(&self, other: &PressedKeyState<K>) -> 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> StructuralPartialEq for PressedKeyState<K>

Auto Trait Implementations§

§

impl<K> Freeze for PressedKeyState<K>
where <K as Key>::PressedKey: Freeze,

§

impl<K> RefUnwindSafe for PressedKeyState<K>
where <K as Key>::PressedKey: RefUnwindSafe,

§

impl<K> Send for PressedKeyState<K>
where <K as Key>::PressedKey: Send,

§

impl<K> Sync for PressedKeyState<K>
where <K as Key>::PressedKey: Sync,

§

impl<K> Unpin for PressedKeyState<K>
where <K as Key>::PressedKey: Unpin,

§

impl<K> UnwindSafe for PressedKeyState<K>
where <K as Key>::PressedKey: 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> 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, 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.