Struct crossterm::event::KeyEventState
source · pub struct KeyEventState(_);
Expand description
Represents extra state about the key event.
Note: This state can only be read if
KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES
has been enabled with
PushKeyboardEnhancementFlags
.
Implementations§
source§impl KeyEventState
impl KeyEventState
sourcepub const CAPS_LOCK: Self = _
pub const CAPS_LOCK: Self = _
Caps Lock was enabled for this key event.
Note: this is set for the initial press of Caps Lock itself.
sourcepub const NUM_LOCK: Self = _
pub const NUM_LOCK: Self = _
Num Lock was enabled for this key event.
Note: this is set for the initial press of Num Lock itself.
pub const NONE: Self = _
source§impl KeyEventState
impl KeyEventState
sourcepub const fn from_bits(bits: u8) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u8) -> Self
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).
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: Self)
pub fn insert(&mut self, other: Self)
Inserts the specified flags in-place.
This method is equivalent to union
.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
Removes the specified flags in-place.
This method is equivalent to difference
.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
Toggles the specified flags in-place.
This method is equivalent to symmetric_difference
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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.
sourcepub const fn union(self, other: Self) -> Self
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.
sourcepub const fn difference(self, other: Self) -> Self
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)
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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.
sourcepub const fn complement(self) -> Self
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.
source§impl KeyEventState
impl KeyEventState
sourcepub const fn iter(&self) -> Iter<KeyEventState>
pub const fn iter(&self) -> Iter<KeyEventState>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<KeyEventState>
pub const fn iter_names(&self) -> IterNames<KeyEventState>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for KeyEventState
impl Binary for KeyEventState
source§impl BitAnd<KeyEventState> for KeyEventState
impl BitAnd<KeyEventState> for KeyEventState
source§impl BitAndAssign<KeyEventState> for KeyEventState
impl BitAndAssign<KeyEventState> for KeyEventState
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<KeyEventState> for KeyEventState
impl BitOr<KeyEventState> for KeyEventState
source§fn bitor(self, other: KeyEventState) -> Self
fn bitor(self, other: KeyEventState) -> Self
Returns the union of the two sets of flags.
§type Output = KeyEventState
type Output = KeyEventState
|
operator.source§impl BitOrAssign<KeyEventState> for KeyEventState
impl BitOrAssign<KeyEventState> for KeyEventState
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<KeyEventState> for KeyEventState
impl BitXor<KeyEventState> for KeyEventState
source§impl BitXorAssign<KeyEventState> for KeyEventState
impl BitXorAssign<KeyEventState> for KeyEventState
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for KeyEventState
impl Clone for KeyEventState
source§fn clone(&self) -> KeyEventState
fn clone(&self) -> KeyEventState
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for KeyEventState
impl Debug for KeyEventState
source§impl<'de> Deserialize<'de> for KeyEventState
impl<'de> Deserialize<'de> for KeyEventState
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
source§impl Extend<KeyEventState> for KeyEventState
impl Extend<KeyEventState> for KeyEventState
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for KeyEventState
impl Flags for KeyEventState
source§const FLAGS: &'static [Flag<KeyEventState>] = _
const FLAGS: &'static [Flag<KeyEventState>] = _
source§fn from_bits_retain(bits: u8) -> KeyEventState
fn from_bits_retain(bits: u8) -> KeyEventState
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where Self: Sized,
source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
source§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where Self: Sized,
source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
self
and other
.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
self
and other
.source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
self
and other
.source§fn complement(self) -> Self
fn complement(self) -> Self
source§impl FromIterator<KeyEventState> for KeyEventState
impl FromIterator<KeyEventState> for KeyEventState
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for KeyEventState
impl Hash for KeyEventState
source§impl IntoIterator for KeyEventState
impl IntoIterator for KeyEventState
source§impl LowerHex for KeyEventState
impl LowerHex for KeyEventState
source§impl Not for KeyEventState
impl Not for KeyEventState
source§impl Octal for KeyEventState
impl Octal for KeyEventState
source§impl PartialEq<KeyEventState> for KeyEventState
impl PartialEq<KeyEventState> for KeyEventState
source§fn eq(&self, other: &KeyEventState) -> bool
fn eq(&self, other: &KeyEventState) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<KeyEventState> for KeyEventState
impl PartialOrd<KeyEventState> for KeyEventState
source§fn partial_cmp(&self, other: &KeyEventState) -> Option<Ordering>
fn partial_cmp(&self, other: &KeyEventState) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PublicFlags for KeyEventState
impl PublicFlags for KeyEventState
source§impl Serialize for KeyEventState
impl Serialize for KeyEventState
source§impl Sub<KeyEventState> for KeyEventState
impl Sub<KeyEventState> for KeyEventState
source§impl SubAssign<KeyEventState> for KeyEventState
impl SubAssign<KeyEventState> for KeyEventState
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.