Struct Context

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

Chord definitions.

Implementations§

Source§

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

Source

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

Constructs a context from the given config

Source

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

Updates the context with the given keymap context.

Source

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§

Source§

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>

Source§

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

Returns a duplicate 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<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>

Source§

type Event = Event

The type of Event the context handles.
Source§

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

Used to update the Context’s state.
Source§

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>

Source§

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

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

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>

Source§

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 ==.
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<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>

Source§

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>

Auto Trait Implementations§

§

impl<const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Freeze 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> RefUnwindSafe 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> Send 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> Sync 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> Unpin 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> UnwindSafe for Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.