Struct ModifiersState 

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

Represents the current logical state of the keyboard modifiers

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

Note that the modifier key can be physically released with the modifier still being marked as active, as in the case of sticky modifiers. See ModifiersKeyState for more details on what “sticky” means.

Implementations

impl ModifiersState

pub const SHIFT: ModifiersState

The “shift” key.

pub const CONTROL: ModifiersState

The “control” key.

pub const ALT: ModifiersState

The “alt” key.

pub const META: ModifiersState

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

pub const SUPER: ModifiersState

👎Deprecated: use META instead

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) -> u32

Get the underlying bits value.

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

pub const fn from_bits(bits: u32) -> 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: u32) -> ModifiersState

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> 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 self 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 other are also set in self.

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

Whether all set bits in other are also set in self.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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 self and other.

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 self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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 self and other.

pub const fn complement(self) -> ModifiersState

The bitwise negation (!) of the bits in self, 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 shift_key(&self) -> bool

Returns whether the shift modifier is active.

pub fn control_key(&self) -> bool

Returns whether the control modifier is active.

pub fn alt_key(&self) -> bool

Returns whether the alt modifier is active.

pub fn meta_key(&self) -> bool

Returns whether the meta modifier is active.

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 self and other.

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 self and other.

impl BitOr for ModifiersState

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

The bitwise or (|) of the bits in self and other.

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 self and other.

impl BitXor for ModifiersState

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

The bitwise exclusive-or (^) of the bits in self and other.

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 self and other.

impl Clone for ModifiersState

fn clone(&self) -> ModifiersState

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

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ModifiersState

Convert from a bits value exactly.

fn all_named() -> ModifiersState

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are 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 iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

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 other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

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 clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl From<ModifiersState> for Modifiers

fn from(value: ModifiersState) -> Modifiers

Converts to this type from the input type.

impl From<ModifiersState> for ModifiersState

fn from(mods: ModifiersState) -> ModifiersState

Converts to this type from the input type.

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 self, 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 Ord for ModifiersState

fn cmp(&self, other: &ModifiersState) -> 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.

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

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

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

The intersection of self with the complement of other (&!).

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 self with the complement of other (&!).

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