Struct ModifierState

pub struct ModifierState { /* private fields */ }

Tracks the current state of “significant” modifier keys.

Currently, a modifier key is “significant” if it affects the mapping of a Fuchsia key to a key meaning.

Implementations

impl ModifierState

pub fn new() -> Self

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

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

Unconditionally adds the given modifier into the modifier state as actuated.

Returns Self for chaining.

pub fn get_state(&self) -> Modifiers

Retrieves the modifier state.

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

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

Returns Self for chaining.

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

Update the modifier tracker state with this event.

pub fn update_with_key_meaning( &mut self, event: KeyEventType, key_meaning: KeyMeaning, )

Update the modifier tracker with this event.

Trait Implementations

impl Clone for ModifierState

fn clone(&self) -> ModifierState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifierState

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

Formats the value using the given formatter.

impl Default for ModifierState

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ModifierState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ModifierChecker for ModifierState

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

Test if the modifier state contains the modifiers from value.

impl PartialEq for ModifierState

fn eq(&self, other: &ModifierState) -> 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 Copy for ModifierState

impl Eq for ModifierState

impl StructuralPartialEq for ModifierState