Struct crossterm::event::KeyModifiers

pub struct KeyModifiers(_);

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: Self = _

pub const CONTROL: Self = _

pub const ALT: Self = _

pub const SUPER: Self = _

pub const HYPER: Self = _

pub const META: Self = _

pub const NONE: Self = _

impl KeyModifiers

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

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

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

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

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

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

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

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the 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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

This method is equivalent to union.

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

Removes the specified flags in-place.

This method is equivalent to difference.

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

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

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

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

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

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

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

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

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

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

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

impl KeyModifiers

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

Iterate over enabled flag values.

pub const fn iter_names(&self) -> IterNames<KeyModifiers>

Iterate over enabled flag values with their stringified names.

Trait Implementations

impl Binary for KeyModifiers

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

Formats the value using the given formatter.

impl BitAnd<KeyModifiers> for KeyModifiers

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

Returns the intersection between the two sets of flags.

type Output = KeyModifiers

The resulting type after applying the & operator.

impl BitAndAssign<KeyModifiers> for KeyModifiers

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<KeyModifiers> for KeyModifiers

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

Returns the union of the two sets of flags.

type Output = KeyModifiers

The resulting type after applying the | operator.

impl BitOrAssign<KeyModifiers> for KeyModifiers

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<KeyModifiers> for KeyModifiers

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

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

type Output = KeyModifiers

The resulting type after applying the ^ operator.

impl BitXorAssign<KeyModifiers> for KeyModifiers

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyModifiers

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<KeyModifiers> for KeyModifiers

fn extend<T: IntoIterator<Item = Self>>(&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 Flags for KeyModifiers

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

The set of available flags and their names.

type Bits = u8

The underlying storage type.

fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u8) -> KeyModifiers

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

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn from_bits(bits: Self::Bits) -> Option<Self>

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

fn from_bits_truncate(bits: Self::Bits) -> Self

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

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

Get the flag for a particular name.

fn iter(&self) -> Iter<Self>

Iterate over enabled flag values.

fn iter_names(&self) -> IterNames<Self>

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

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

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

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

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place.

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

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

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

Returns the intersection between the flags in self and other.

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

Returns the union of between the flags in self and other.

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

Returns the difference between the flags in self and other.

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

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl From<&ControlKeyState> for KeyModifiers

fn from(state: &ControlKeyState) -> Self

Converts to this type from the input type.

impl FromIterator<KeyModifiers> for KeyModifiers

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

Creates a value from an iterator.

impl Hash for KeyModifiers

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

Creates an iterator from a value.

impl LowerHex for KeyModifiers

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

Formats the value using the given formatter.

impl Not for KeyModifiers

fn not(self) -> Self

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

Formats the value using the given formatter.

impl PartialEq<KeyModifiers> for KeyModifiers

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PublicFlags for KeyModifiers

type Primitive = u8

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Serialize for KeyModifiers

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<KeyModifiers> for KeyModifiers

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

Returns the set difference of the two sets of flags.

type Output = KeyModifiers

The resulting type after applying the - operator.

impl SubAssign<KeyModifiers> for KeyModifiers

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for KeyModifiers

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

Formats the value using the given formatter.

impl Copy for KeyModifiers

impl Eq for KeyModifiers

impl StructuralEq for KeyModifiers

impl StructuralPartialEq for KeyModifiers