Struct crossterm::event::KeyboardEnhancementFlags
source · pub struct KeyboardEnhancementFlags(_);
Expand description
Represents special flags that tell compatible terminals to add extra information to keyboard events.
See https://sw.kovidgoyal.net/kitty/keyboard-protocol/#progressive-enhancement for more information.
Alternate keys and Unicode codepoints are not yet supported by crossterm.
Implementations§
source§impl KeyboardEnhancementFlags
impl KeyboardEnhancementFlags
sourcepub const DISAMBIGUATE_ESCAPE_CODES: Self = _
pub const DISAMBIGUATE_ESCAPE_CODES: Self = _
Represent Escape and modified keys using CSI-u sequences, so they can be unambiguously read.
sourcepub const REPORT_EVENT_TYPES: Self = _
pub const REPORT_EVENT_TYPES: Self = _
Add extra events with [KeyEvent.kind
] set to KeyEventKind::Repeat
or
KeyEventKind::Release
when keys are autorepeated or released.
pub const REPORT_ALTERNATE_KEYS: Self = _
sourcepub const REPORT_ALL_KEYS_AS_ESCAPE_CODES: Self = _
pub const REPORT_ALL_KEYS_AS_ESCAPE_CODES: Self = _
Represent all keyboard events as CSI-u sequences. This is required to get repeat/release events for plain-text keys.
source§impl KeyboardEnhancementFlags
impl KeyboardEnhancementFlags
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 KeyboardEnhancementFlags
impl KeyboardEnhancementFlags
sourcepub const fn iter(&self) -> Iter<KeyboardEnhancementFlags>
pub const fn iter(&self) -> Iter<KeyboardEnhancementFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<KeyboardEnhancementFlags>
pub const fn iter_names(&self) -> IterNames<KeyboardEnhancementFlags>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for KeyboardEnhancementFlags
impl Binary for KeyboardEnhancementFlags
source§impl BitAndAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitAndAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
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<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitOr<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
source§fn bitor(self, other: KeyboardEnhancementFlags) -> Self
fn bitor(self, other: KeyboardEnhancementFlags) -> Self
Returns the union of the two sets of flags.
§type Output = KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
|
operator.source§impl BitOrAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitOrAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitXorAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for KeyboardEnhancementFlags
impl Clone for KeyboardEnhancementFlags
source§fn clone(&self) -> KeyboardEnhancementFlags
fn clone(&self) -> KeyboardEnhancementFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for KeyboardEnhancementFlags
impl Debug for KeyboardEnhancementFlags
source§impl<'de> Deserialize<'de> for KeyboardEnhancementFlags
impl<'de> Deserialize<'de> for KeyboardEnhancementFlags
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<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl Extend<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
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 KeyboardEnhancementFlags
impl Flags for KeyboardEnhancementFlags
source§const FLAGS: &'static [Flag<KeyboardEnhancementFlags>] = _
const FLAGS: &'static [Flag<KeyboardEnhancementFlags>] = _
source§fn from_bits_retain(bits: u8) -> KeyboardEnhancementFlags
fn from_bits_retain(bits: u8) -> KeyboardEnhancementFlags
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<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl FromIterator<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
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 KeyboardEnhancementFlags
impl Hash for KeyboardEnhancementFlags
source§impl LowerHex for KeyboardEnhancementFlags
impl LowerHex for KeyboardEnhancementFlags
source§impl Not for KeyboardEnhancementFlags
impl Not for KeyboardEnhancementFlags
source§impl Octal for KeyboardEnhancementFlags
impl Octal for KeyboardEnhancementFlags
source§impl PartialEq<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl PartialEq<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
source§fn eq(&self, other: &KeyboardEnhancementFlags) -> bool
fn eq(&self, other: &KeyboardEnhancementFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl PartialOrd<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
source§fn partial_cmp(&self, other: &KeyboardEnhancementFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &KeyboardEnhancementFlags) -> 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 KeyboardEnhancementFlags
impl PublicFlags for KeyboardEnhancementFlags
source§impl Serialize for KeyboardEnhancementFlags
impl Serialize for KeyboardEnhancementFlags
source§impl SubAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl SubAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.