Struct ModifiersState

pub struct ModifiersState(/* private fields */);

Represents the current state of the keyboard modifiers.

Each flag represents a modifier and is set if this modifier is active.

Implementations

impl ModifiersState

pub const L_SHIFT: ModifiersState = _

The left “shift” key.

pub const R_SHIFT: ModifiersState = _

The right “shift” key.

pub const SHIFT: ModifiersState = _

Any “shift” key.

pub const L_CTRL: ModifiersState = _

The left “control” key.

pub const R_CTRL: ModifiersState = _

The right “control” key.

pub const CTRL: ModifiersState = _

Any “control” key.

pub const L_ALT: ModifiersState = _

The left “alt” key.

pub const R_ALT: ModifiersState = _

The right “alt” key.

pub const ALT: ModifiersState = _

Any “alt” key.

pub const L_LOGO: ModifiersState = _

The left “logo” key.

pub const R_LOGO: ModifiersState = _

The right “logo” key.

pub const LOGO: ModifiersState = _

Any “logo” key.

This is the “windows” key on PC and “command” key on Mac.

impl ModifiersState

pub const fn empty() -> ModifiersState

Get a flags value with all bits unset.

pub const fn all() -> ModifiersState

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<ModifiersState>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> ModifiersState

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> ModifiersState

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<ModifiersState>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: ModifiersState) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: ModifiersState) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: ModifiersState)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: ModifiersState)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: ModifiersState)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: ModifiersState, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: ModifiersState) -> ModifiersState

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: ModifiersState) -> ModifiersState

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: ModifiersState) -> ModifiersState

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: ModifiersState) -> ModifiersState

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> ModifiersState

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ModifiersState

pub const fn iter(&self) -> Iter<ModifiersState>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ModifiersState>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl ModifiersState

pub fn has_shift(self) -> bool

Returns true if any shift key is pressed.

pub fn has_ctrl(self) -> bool

Returns true if any control key is pressed.

pub fn has_alt(self) -> bool

Returns true if any alt key is pressed.

pub fn has_super(self) -> bool

Returns true if any logo key is pressed.

pub fn is_only(self, part: ModifiersState) -> bool

Returns true if only any flag in part is pressed.

pub fn is_only_shift(self) -> bool

Returns true if only any shift key is pressed.

pub fn is_only_ctrl(self) -> bool

Returns true if only any control key is pressed.

pub fn is_only_alt(self) -> bool

Returns true if only any alt key is pressed.

pub fn is_only_logo(self) -> bool

Returns true if only any logo key is pressed.

pub fn take(&mut self, part: ModifiersState) -> bool

Removes part and returns if it was removed.

pub fn take_shift(&mut self) -> bool

Removes SHIFT and returns if it was removed.

pub fn take_ctrl(&mut self) -> bool

Removes CTRL and returns if it was removed.

pub fn take_alt(&mut self) -> bool

Removes ALT and returns if it was removed.

pub fn take_logo(&mut self) -> bool

Removes LOGO and returns if it was removed.

pub fn ambit(self) -> ModifiersState

Returns modifiers that set both left and right flags if any side is set in self.

pub fn into_alt(self) -> ModifiersState

Returns only the alt flags in self.

pub fn into_ctrl(self) -> ModifiersState

Returns only the control flags in self.

pub fn into_shift(self) -> ModifiersState

Returns only the shift flags in self.

pub fn into_logo(self) -> ModifiersState

Returns only the logo flags in self.

pub fn from_code(code: KeyCode) -> ModifiersState

Modifier from code, returns empty if the key is not a modifier.

pub fn from_key(key: Key) -> ModifiersState

Modifier from key, returns empty if the key is not a modifier.

pub fn codes(self) -> Vec<KeyCode>

All key codes that when pressed form the modifiers state.

In case of multiple keys the order is LOGO, CTRL, SHIFT, ALT.

In case both left and right keys are flagged for a modifier, the left key is used.

pub fn keys(self) -> Vec<Key>

All keys that when pressed form the modifiers state.

In case of multiple keys the order is LOGO, CTRL, SHIFT, ALT.

Trait Implementations

impl Binary for ModifiersState

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

Formats the value using the given formatter.

impl BitAnd for ModifiersState

fn bitand(self, other: ModifiersState) -> ModifiersState

The bitwise and (&) of the bits in two flags values.

type Output = ModifiersState

The resulting type after applying the & operator.

impl BitAndAssign for ModifiersState

fn bitand_assign(&mut self, other: ModifiersState)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ModifiersState

fn bitor(self, other: ModifiersState) -> ModifiersState

The bitwise or (|) of the bits in two flags values.

type Output = ModifiersState

The resulting type after applying the | operator.

impl BitOrAssign for ModifiersState

fn bitor_assign(&mut self, other: ModifiersState)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ModifiersState

fn bitxor(self, other: ModifiersState) -> ModifiersState

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ModifiersState

The resulting type after applying the ^ operator.

impl BitXorAssign for ModifiersState

fn bitxor_assign(&mut self, other: ModifiersState)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for ModifiersState

fn clone(&self) -> ModifiersState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifiersState

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

Formats the value using the given formatter.

impl Default for ModifiersState

fn default() -> ModifiersState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModifiersState

fn deserialize<__D>( __deserializer: __D, ) -> Result<ModifiersState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<ModifiersState> for ModifiersState

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = ModifiersState>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ModifiersState

const FLAGS: &'static [Flag<ModifiersState>] = _

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> ModifiersState

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<ModifiersState> for ModifiersState

fn from_iter<T>(iterator: T) -> ModifiersState

where T: IntoIterator<Item = ModifiersState>,

The bitwise or (|) of the bits in each flags value.

impl Hash for ModifiersState

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

where __H: Hasher,

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 IntoIterator for ModifiersState

type Item = ModifiersState

The type of the elements being iterated over.

type IntoIter = Iter<ModifiersState>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ModifiersState as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for ModifiersState

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

Formats the value using the given formatter.

impl Not for ModifiersState

fn not(self) -> ModifiersState

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ModifiersState

The resulting type after applying the ! operator.

impl Octal for ModifiersState

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

Formats the value using the given formatter.

impl PartialEq for ModifiersState

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for ModifiersState

fn sub(self, other: ModifiersState) -> ModifiersState

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ModifiersState

The resulting type after applying the - operator.

impl SubAssign for ModifiersState

fn sub_assign(&mut self, other: ModifiersState)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ModifiersState

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

Formats the value using the given formatter.

impl Copy for ModifiersState

impl Eq for ModifiersState

impl StructuralPartialEq for ModifiersState