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 fn shift(&self) -> bool

Returns true if the shift key is pressed.

pub fn ctrl(&self) -> bool

Returns true if the control key is pressed.

pub fn alt(&self) -> bool

Returns true if the alt key is pressed.

pub fn logo(&self) -> bool

Returns true if the logo key is pressed.

impl ModifiersState

pub const SHIFT: ModifiersState

The “shift” key.

pub const CTRL: ModifiersState

The “control” key.

pub const ALT: ModifiersState

The “alt” key.

pub const LOGO: ModifiersState

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

pub const fn empty() -> ModifiersState

Returns an empty set of flags

pub const fn all() -> ModifiersState

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> ModifiersState

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ModifiersState

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

Formats the value using the given formatter.

impl BitAnd for ModifiersState

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

Returns the intersection between the two sets of flags.

type Output = ModifiersState

The resulting type after applying the & operator.

impl BitAndAssign for ModifiersState

fn bitand_assign(&mut self, other: ModifiersState)

Disables all flags disabled in the set.

impl BitOr for ModifiersState

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

Returns the union of the two sets of flags.

type Output = ModifiersState

The resulting type after applying the | operator.

impl BitOrAssign for ModifiersState

fn bitor_assign(&mut self, other: ModifiersState)

Adds the set of flags.

impl BitXor for ModifiersState

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

Returns the left flags, but with all the right flags toggled.

type Output = ModifiersState

The resulting type after applying the ^ operator.

impl BitXorAssign for ModifiersState

fn bitxor_assign(&mut self, other: ModifiersState)

Toggles the set of flags.

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

impl Debug for ModifiersState

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

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<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModifiersState

impl Extend<ModifiersState> for ModifiersState

fn extend<T: IntoIterator<Item = ModifiersState>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

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 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: IntoIterator<Item = ModifiersState>>( iterator: T, ) -> ModifiersState

Creates a value from an iterator.

impl Hash for ModifiersState

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

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

Formats the value using the given formatter.

impl Not for ModifiersState

fn not(self) -> ModifiersState

Returns the complement of this set of flags.

type Output = ModifiersState

The resulting type after applying the ! operator.

impl Octal for ModifiersState

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

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

Equality operator ==.

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

Inequality operator !=.

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModifiersState

impl Sub for ModifiersState

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

Returns the set difference of the two sets of flags.

type Output = ModifiersState

The resulting type after applying the - operator.

impl SubAssign for ModifiersState

fn sub_assign(&mut self, other: ModifiersState)

Disables all flags enabled in the set.

impl UpperHex for ModifiersState

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

Formats the value using the given formatter.