Enum ModifiersKeyState 

pub enum ModifiersKeyState {
    Pressed,
    Unknown,
}

The logical state of the particular modifiers key.

NOTE: while the modifier can only be in a binary active/inactive state, it might be helpful to note the context re. how its state changes by physical key events.

↓ / ↑ denote physical press/release¹:

Type	Activated	Deactivated	Comment
Regular	↓	↑	Active while being held
Sticky	↓	↓ unless lock is enabled ↓/↑2 non-sticky key	Temporarily “stuck”; other Sticky keys have no effect
Sticky Locked	↓ if Sticky	↓	Similar to Toggle, but deactivating ↓ turns on Regular effect
Toggle	↓	↓	↑ from the activating ↓ has no effect

Sticky effect avoids the need to press and hold multiple modifiers for a single shortcut and is usually a platform-wide option that affects modifiers commonly used in shortcuts: Shift, Control, Alt, Meta.

Toggle type is typically a property of a modifier, for example, Caps Lock.

These active states are not differentiated here.

---

1. For virtual/on-screen keyboards physical press/release can be a mouse click or a finger tap or a voice command. ↩

2. platform-dependent ↩

Variants

Pressed

The particular modifier is active or logically, but not necessarily physically, pressed.

Unknown

The state of the key is unknown.

Can include cases when the key is active or logically pressed, for example, when a sticky Shift is active, the OS might not preserve information that it was activated by RightShift, so the state of ModifiersKeys::RSHIFT will be unknown while the state of ModifiersState::SHIFT will be active.

Trait Implementations

impl Clone for ModifiersKeyState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ModifiersKeyState

impl Debug for ModifiersKeyState

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

Formats the value using the given formatter.

impl Default for ModifiersKeyState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ModifiersKeyState

impl Hash for ModifiersKeyState

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 Ord for ModifiersKeyState

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ModifiersKeyState

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for ModifiersKeyState

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ModifiersKeyState