Struct KeyModifiers

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

Available on crate features dep_crossterm and std only.

Represents key modifiers (shift, control, alt, etc.).

Note: SUPER, HYPER, and META can only be read if KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES has been enabled with PushKeyboardEnhancementFlags.

Implementations

impl KeyModifiers

pub const SHIFT: KeyModifiers

pub const CONTROL: KeyModifiers

pub const ALT: KeyModifiers

pub const SUPER: KeyModifiers

pub const HYPER: KeyModifiers

pub const META: KeyModifiers

pub const NONE: KeyModifiers

impl KeyModifiers

pub const fn empty() -> KeyModifiers

Get a flags value with all bits unset.

pub const fn all() -> KeyModifiers

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

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub const fn complement(self) -> KeyModifiers

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

impl KeyModifiers

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

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

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.

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

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

type Output = KeyModifiers

The resulting type after applying the & operator.

impl BitAndAssign for KeyModifiers

fn bitand_assign(&mut self, other: KeyModifiers)

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

impl BitOr for KeyModifiers

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

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

type Output = KeyModifiers

The resulting type after applying the | operator.

impl BitOrAssign for KeyModifiers

fn bitor_assign(&mut self, other: KeyModifiers)

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

impl BitXor for KeyModifiers

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

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

type Output = KeyModifiers

The resulting type after applying the ^ operator.

impl BitXorAssign for KeyModifiers

fn bitxor_assign(&mut self, other: KeyModifiers)

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

impl Clone for KeyModifiers

fn clone(&self) -> KeyModifiers

Returns a copy 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 Display for KeyModifiers

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

Formats the key modifiers using the given formatter.

The key modifiers are joined by a + character.

Platform-specific Notes

On macOS, the control, alt, and super keys is displayed as “Control”, “Option”, and “Command” respectively. See https://support.apple.com/guide/applestyleguide/welcome/1.0/web.

On Windows, the super key is displayed as “Windows” and the control key is displayed as “Ctrl”. See https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/keys-keyboard-shortcuts.

On other platforms, the super key is referred to as “Super” and the control key is displayed as “Ctrl”.

impl Extend<KeyModifiers> for KeyModifiers

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

where T: IntoIterator<Item = KeyModifiers>,

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 KeyModifiers

const FLAGS: &'static [Flag<KeyModifiers>]

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

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

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

where T: IntoIterator<Item = KeyModifiers>,

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

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

type Item = KeyModifiers

The type of the elements being iterated over.

type IntoIter = Iter<KeyModifiers>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

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

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

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

The resulting type after applying the - operator.

impl SubAssign for KeyModifiers

fn sub_assign(&mut self, other: KeyModifiers)

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