Struct LockStateKeys

pub struct LockStateKeys { /* private fields */ }

The lock state of the lock keys.

Consult the state diagram below for the intended state transition. The state encoding is given in [State].

Key    """""""\_________/"""""""""""\_________/""""
State  -------<    S1  ><     S2   ><    S3   >----

Any other state is not explicitly accounted for: the state of “the lock is not active” is encoded by not having a record of the key state. This allows us to implement the state machine for an arbitrary number of lock keys.

Implementations

impl LockStateKeys

pub fn new() -> Self

Creates a new LockStateKeys initializes with the default state (no modifiers are actuated).

pub fn with(self, value: LockState) -> Self

Unconditionally adds the given lock state as actuated.

Returns Self for chaining.

pub fn with_if(self, value: LockState, set: bool) -> Self

Adds value into the modifier state as actuated, if set is true. Otherwise makes no changes to LockStateKeys.

Returns Self for chaining.

pub fn update(&mut self, event: KeyEventType, key: Key)

Update the modifier tracker state with this event.

pub fn get_state(&self) -> LockState

Gets the recorded lock state.

Trait Implementations

impl Debug for LockStateKeys

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

Formats the value using the given formatter.

impl Default for LockStateKeys

fn default() -> Self

Returns the “default value” for a type.

impl LockStateChecker for LockStateKeys

fn test(&self, value: LockState) -> bool

Returns true if the lock state value is set.