RKTK API Docs RKTK Home Repo

Struct State

Source
pub struct State<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> { /* private fields */ }
Available on crate feature state only.
Expand description

Represents the state of the keyboard.

Implementations§

Source§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> State<LAYER, ROW, COL, ENCODER_COUNT, NORMAL_MAX_PRESSED_KEYS, ONESHOT_STATE_SIZE, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

Source

pub fn new( keymap: Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>, config: StateConfig, ) -> Self

Creates a new state with the given keymap and configuration.

Source

pub fn get_keymap( &self, ) -> &Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

Source

pub fn get_config(&self) -> &StateConfig

Source

pub fn get_layer_active(&self) -> &[bool; LAYER]

Source

pub fn get_keymap_info() -> KeymapInfo

Source

pub fn update( &mut self, event: InputEvent, since_last_update: Duration, cb: impl FnMut(OutputEvent), )

Auto Trait Implementations§

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Freeze for State<LAYER, ROW, COL, ENCODER_COUNT, NORMAL_MAX_PRESSED_KEYS, ONESHOT_STATE_SIZE, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> RefUnwindSafe for State<LAYER, ROW, COL, ENCODER_COUNT, NORMAL_MAX_PRESSED_KEYS, ONESHOT_STATE_SIZE, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Send for State<LAYER, ROW, COL, ENCODER_COUNT, NORMAL_MAX_PRESSED_KEYS, ONESHOT_STATE_SIZE, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Sync for State<LAYER, ROW, COL, ENCODER_COUNT, NORMAL_MAX_PRESSED_KEYS, ONESHOT_STATE_SIZE, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Unpin for State<LAYER, ROW, COL, ENCODER_COUNT, NORMAL_MAX_PRESSED_KEYS, ONESHOT_STATE_SIZE, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const NORMAL_MAX_PRESSED_KEYS: usize, const ONESHOT_STATE_SIZE: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> UnwindSafe for State<LAYER, ROW, COL, ENCODER_COUNT, NORMAL_MAX_PRESSED_KEYS, ONESHOT_STATE_SIZE, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

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.