Struct Context

pub struct Context<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> { /* private fields */ }

Chord definitions.

Implementations

impl<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

pub const fn from_config(config: Config<MAX_CHORDS, MAX_CHORD_SIZE>) -> Self

Constructs a context from the given config

pub fn update_keymap_context(&mut self, _: &KeymapContext)

Updates the context with the given keymap context.

pub fn chords_for_keymap_index( &self, keymap_index: u16, ) -> Vec<ChordState<MAX_CHORD_SIZE>, MAX_CHORDS>

Returns the chords for the given keymap index.

• If a chord with that index is resolved as active, return a vec with only that chord.
• Otherwise, return a vec with all the chords which include the keymap index and could be satisfied. (i.e. chords which do not overlap with resolved active chords).

Trait Implementations

impl<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Clone for Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

fn clone(&self) -> Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Context for Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

type Event = Event

The type of Event the context handles.

fn handle_event(&mut self, event: Event<Self::Event>) -> KeyEvents<Self::Event>

Used to update the Context’s state.

impl<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Debug for Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

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

Formats the value using the given formatter.

impl<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> PartialEq for Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

fn eq( &self, other: &Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>, ) -> 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<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Copy for Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

impl<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> StructuralPartialEq for Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>