Struct keycodes_ascii::KeyboardModifiers

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

The set of modifier keys that can be held down while other keys are pressed.

To save space, this is expressed using bitflags rather than a series of individual booleans, because Rust’s bool type is a whole byte.

Implementations

impl KeyboardModifiers

pub const CONTROL_LEFT: Self = _

pub const CONTROL_RIGHT: Self = _

pub const SHIFT_LEFT: Self = _

pub const SHIFT_RIGHT: Self = _

pub const ALT: Self = _

pub const ALT_GR: Self = _

pub const SUPER_KEY_LEFT: Self = _

pub const SUPER_KEY_RIGHT: Self = _

pub const CAPS_LOCK: Self = _

pub const NUM_LOCK: Self = _

pub const SCROLL_LOCK: Self = _

impl KeyboardModifiers

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

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

pub const fn from_bits(bits: u16) -> Option<Self>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u16) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> Self

Convert from a bits value exactly.

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

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

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

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

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

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

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

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

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: Self)

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

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

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

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

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

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

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

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

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: Self) -> Self

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

pub const fn complement(self) -> Self

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

impl KeyboardModifiers

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

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<KeyboardModifiers>

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 KeyboardModifiers

pub const fn new() -> KeyboardModifiers

Returns a new KeyboardModifiers struct with no keys pressed.

pub fn is_shift(&self) -> bool

Returns true if a Shift key is held down (either left or right).

pub fn is_control(&self) -> bool

Returns true if a Control key is held down (either left or right).

pub fn is_alt(&self) -> bool

Returns true if the Alt key is held down.

pub fn is_alt_gr(&self) -> bool

Returns true if the AltGr key is held down.

pub fn is_super_key(&self) -> bool

Returns true if a Super key is held down (either left or right).

Examples include the Windows key, the Meta key, the command key, etc.

pub fn is_caps_lock(&self) -> bool

Returns true if the Caps Lock key is held down.

pub fn is_num_lock(&self) -> bool

Returns true if the Num Lock key is held down.

pub fn is_scroll_lock(&self) -> bool

Returns true if the Scroll Lock key is held down.

Trait Implementations

impl Binary for KeyboardModifiers

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

Formats the value using the given formatter.

impl BitAnd<KeyboardModifiers> for KeyboardModifiers

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

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

type Output = KeyboardModifiers

The resulting type after applying the & operator.

impl BitAndAssign<KeyboardModifiers> for KeyboardModifiers

fn bitand_assign(&mut self, other: Self)

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

impl BitOr<KeyboardModifiers> for KeyboardModifiers

fn bitor(self, other: KeyboardModifiers) -> Self

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

type Output = KeyboardModifiers

The resulting type after applying the | operator.

impl BitOrAssign<KeyboardModifiers> for KeyboardModifiers

fn bitor_assign(&mut self, other: Self)

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

impl BitXor<KeyboardModifiers> for KeyboardModifiers

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

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

type Output = KeyboardModifiers

The resulting type after applying the ^ operator.

impl BitXorAssign<KeyboardModifiers> for KeyboardModifiers

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for KeyboardModifiers

fn clone(&self) -> KeyboardModifiers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardModifiers

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

Formats the value using the given formatter.

impl Default for KeyboardModifiers

fn default() -> Self

Returns the “default value” for a type.

impl Extend<KeyboardModifiers> for KeyboardModifiers

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

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 KeyboardModifiers

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

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> KeyboardModifiers

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) -> boolwhere Self: Sized,

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

fn contains(&self, other: Self) -> boolwhere 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<KeyboardModifiers> for KeyboardModifiers

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

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

impl IntoIterator for KeyboardModifiers

type Item = KeyboardModifiers

The type of the elements being iterated over.

type IntoIter = Iter<KeyboardModifiers>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for KeyboardModifiers

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

Formats the value using the given formatter.

impl Not for KeyboardModifiers

fn not(self) -> Self

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

type Output = KeyboardModifiers

The resulting type after applying the ! operator.

impl Octal for KeyboardModifiers

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

Formats the value using the given formatter.

impl PartialEq<KeyboardModifiers> for KeyboardModifiers

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PublicFlags for KeyboardModifiers

type Primitive = u16

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub<KeyboardModifiers> for KeyboardModifiers

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

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 = KeyboardModifiers

The resulting type after applying the - operator.

impl SubAssign<KeyboardModifiers> for KeyboardModifiers

fn sub_assign(&mut self, other: Self)

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 KeyboardModifiers

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

Formats the value using the given formatter.

impl Copy for KeyboardModifiers

impl Eq for KeyboardModifiers

impl StructuralEq for KeyboardModifiers

impl StructuralPartialEq for KeyboardModifiers