Struct crossterm::event::KeyboardEnhancementFlags
source · [−]pub struct KeyboardEnhancementFlags { /* private fields */ }
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
sourceimpl 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.
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.
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 unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
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 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
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
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
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
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
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
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
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for KeyboardEnhancementFlags
impl Binary for KeyboardEnhancementFlags
sourceimpl BitAnd<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitAnd<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitAndAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitOr<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn 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
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitOrAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitXor<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl BitXorAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for KeyboardEnhancementFlags
impl Clone for KeyboardEnhancementFlags
sourcefn clone(&self) -> KeyboardEnhancementFlags
fn clone(&self) -> KeyboardEnhancementFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for KeyboardEnhancementFlags
impl Debug for KeyboardEnhancementFlags
sourceimpl<'de> Deserialize<'de> for KeyboardEnhancementFlags
impl<'de> Deserialize<'de> for KeyboardEnhancementFlags
sourcefn 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>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Extend<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl Extend<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl FromIterator<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for KeyboardEnhancementFlags
impl Hash for KeyboardEnhancementFlags
sourceimpl LowerHex for KeyboardEnhancementFlags
impl LowerHex for KeyboardEnhancementFlags
sourceimpl Not for KeyboardEnhancementFlags
impl Not for KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
The resulting type after applying the !
operator.
sourceimpl Octal for KeyboardEnhancementFlags
impl Octal for KeyboardEnhancementFlags
sourceimpl Ord for KeyboardEnhancementFlags
impl Ord for KeyboardEnhancementFlags
sourcefn cmp(&self, other: &KeyboardEnhancementFlags) -> Ordering
fn cmp(&self, other: &KeyboardEnhancementFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl PartialEq<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn eq(&self, other: &KeyboardEnhancementFlags) -> bool
fn eq(&self, other: &KeyboardEnhancementFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &KeyboardEnhancementFlags) -> bool
fn ne(&self, other: &KeyboardEnhancementFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl PartialOrd<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn partial_cmp(&self, other: &KeyboardEnhancementFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &KeyboardEnhancementFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Serialize for KeyboardEnhancementFlags
impl Serialize for KeyboardEnhancementFlags
sourceimpl Sub<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl Sub<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
type Output = KeyboardEnhancementFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
impl SubAssign<KeyboardEnhancementFlags> for KeyboardEnhancementFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for KeyboardEnhancementFlags
impl UpperHex for KeyboardEnhancementFlags
impl Copy for KeyboardEnhancementFlags
impl Eq for KeyboardEnhancementFlags
impl StructuralEq for KeyboardEnhancementFlags
impl StructuralPartialEq for KeyboardEnhancementFlags
Auto Trait Implementations
impl RefUnwindSafe for KeyboardEnhancementFlags
impl Send for KeyboardEnhancementFlags
impl Sync for KeyboardEnhancementFlags
impl Unpin for KeyboardEnhancementFlags
impl UnwindSafe for KeyboardEnhancementFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more