Struct KeyModifiers 

pub struct KeyModifiers { /* private fields */ }

Represents key modifiers (shift, control, alt).

Implementations

impl KeyModifiers

pub const SHIFT: KeyModifiers

pub const CONTROL: KeyModifiers

pub const ALT: KeyModifiers

pub const fn empty() -> KeyModifiers

Returns an empty set of flags

pub const fn all() -> KeyModifiers

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

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

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

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

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> KeyModifiers

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: KeyModifiers) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for KeyModifiers

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

Formats the value using the given formatter.

impl BitAnd for KeyModifiers

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

Returns the intersection between the two sets of flags.

type Output = KeyModifiers

The resulting type after applying the & operator.

impl BitAndAssign for KeyModifiers

fn bitand_assign(&mut self, other: KeyModifiers)

Disables all flags disabled in the set.

impl BitOr for KeyModifiers

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

Returns the union of the two sets of flags.

type Output = KeyModifiers

The resulting type after applying the | operator.

impl BitOrAssign for KeyModifiers

fn bitor_assign(&mut self, other: KeyModifiers)

Adds the set of flags.

impl BitXor for KeyModifiers

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

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

type Output = KeyModifiers

The resulting type after applying the ^ operator.

impl BitXorAssign for KeyModifiers

fn bitxor_assign(&mut self, other: KeyModifiers)

Toggles the set of flags.

impl Clone for KeyModifiers

fn clone(&self) -> KeyModifiers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyModifiers

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

Formats the value using the given formatter.

impl Extend<KeyModifiers> for KeyModifiers

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

where T: IntoIterator<Item = KeyModifiers>,

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 FromIterator<KeyModifiers> for KeyModifiers

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

where T: IntoIterator<Item = KeyModifiers>,

Creates a value from an iterator.

impl Hash for KeyModifiers

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

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

Formats the value using the given formatter.

impl Not for KeyModifiers

fn not(self) -> KeyModifiers

Returns the complement of this set of flags.

type Output = KeyModifiers

The resulting type after applying the ! operator.

impl Octal for KeyModifiers

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

Formats the value using the given formatter.

impl Ord for KeyModifiers

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

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

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

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

Returns the set difference of the two sets of flags.

type Output = KeyModifiers

The resulting type after applying the - operator.

impl SubAssign for KeyModifiers

fn sub_assign(&mut self, other: KeyModifiers)

Disables all flags enabled in the set.

impl UpperHex for KeyModifiers

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

Formats the value using the given formatter.

impl Copy for KeyModifiers

impl Eq for KeyModifiers

impl StructuralPartialEq for KeyModifiers