Struct console_engine::KeyModifiers
source · pub struct KeyModifiers { /* private fields */ }
Expand description
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§
source§impl KeyModifiers
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 = _
sourcepub const fn empty() -> KeyModifiers
pub const fn empty() -> KeyModifiers
Returns an empty set of flags.
sourcepub const fn all() -> KeyModifiers
pub const fn all() -> KeyModifiers
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<KeyModifiers>
pub const fn from_bits(bits: u8) -> Option<KeyModifiers>
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) -> KeyModifiers
pub const fn from_bits_truncate(bits: u8) -> KeyModifiers
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> KeyModifiers
pub const unsafe fn from_bits_unchecked(bits: u8) -> KeyModifiers
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: KeyModifiers) -> bool
pub const fn intersects(&self, other: KeyModifiers) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: KeyModifiers) -> bool
pub const fn contains(&self, other: KeyModifiers) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: KeyModifiers)
pub fn insert(&mut self, other: KeyModifiers)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: KeyModifiers)
pub fn remove(&mut self, other: KeyModifiers)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: KeyModifiers)
pub fn toggle(&mut self, other: KeyModifiers)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: KeyModifiers, value: bool)
pub fn set(&mut self, other: KeyModifiers, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: KeyModifiers) -> KeyModifiers
pub const fn intersection(self, other: KeyModifiers) -> KeyModifiers
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: KeyModifiers) -> KeyModifiers
pub const fn union(self, other: KeyModifiers) -> KeyModifiers
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: KeyModifiers) -> KeyModifiers
pub const fn difference(self, other: KeyModifiers) -> KeyModifiers
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: KeyModifiers) -> KeyModifiers
pub const fn symmetric_difference(self, other: KeyModifiers) -> KeyModifiers
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) -> KeyModifiers
pub const fn complement(self) -> KeyModifiers
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§
source§impl Binary for KeyModifiers
impl Binary for KeyModifiers
source§impl BitAnd for KeyModifiers
impl BitAnd for KeyModifiers
source§fn bitand(self, other: KeyModifiers) -> KeyModifiers
fn bitand(self, other: KeyModifiers) -> KeyModifiers
Returns the intersection between the two sets of flags.
§type Output = KeyModifiers
type Output = KeyModifiers
&
operator.source§impl BitAndAssign for KeyModifiers
impl BitAndAssign for KeyModifiers
source§fn bitand_assign(&mut self, other: KeyModifiers)
fn bitand_assign(&mut self, other: KeyModifiers)
Disables all flags disabled in the set.
source§impl BitOr for KeyModifiers
impl BitOr for KeyModifiers
source§fn bitor(self, other: KeyModifiers) -> KeyModifiers
fn bitor(self, other: KeyModifiers) -> KeyModifiers
Returns the union of the two sets of flags.
§type Output = KeyModifiers
type Output = KeyModifiers
|
operator.source§impl BitOrAssign for KeyModifiers
impl BitOrAssign for KeyModifiers
source§fn bitor_assign(&mut self, other: KeyModifiers)
fn bitor_assign(&mut self, other: KeyModifiers)
Adds the set of flags.
source§impl BitXor for KeyModifiers
impl BitXor for KeyModifiers
source§fn bitxor(self, other: KeyModifiers) -> KeyModifiers
fn bitxor(self, other: KeyModifiers) -> KeyModifiers
Returns the left flags, but with all the right flags toggled.
§type Output = KeyModifiers
type Output = KeyModifiers
^
operator.source§impl BitXorAssign for KeyModifiers
impl BitXorAssign for KeyModifiers
source§fn bitxor_assign(&mut self, other: KeyModifiers)
fn bitxor_assign(&mut self, other: KeyModifiers)
Toggles the set of flags.
source§impl Clone for KeyModifiers
impl Clone for KeyModifiers
source§fn clone(&self) -> KeyModifiers
fn clone(&self) -> KeyModifiers
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for KeyModifiers
impl Debug for KeyModifiers
source§impl Extend<KeyModifiers> for KeyModifiers
impl Extend<KeyModifiers> for KeyModifiers
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = KeyModifiers>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = KeyModifiers>,
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 From<&ControlKeyState> for KeyModifiers
impl From<&ControlKeyState> for KeyModifiers
source§fn from(state: &ControlKeyState) -> KeyModifiers
fn from(state: &ControlKeyState) -> KeyModifiers
source§impl FromIterator<KeyModifiers> for KeyModifiers
impl FromIterator<KeyModifiers> for KeyModifiers
source§fn from_iter<T>(iterator: T) -> KeyModifierswhere
T: IntoIterator<Item = KeyModifiers>,
fn from_iter<T>(iterator: T) -> KeyModifierswhere
T: IntoIterator<Item = KeyModifiers>,
source§impl Hash for KeyModifiers
impl Hash for KeyModifiers
source§impl LowerHex for KeyModifiers
impl LowerHex for KeyModifiers
source§impl Not for KeyModifiers
impl Not for KeyModifiers
source§fn not(self) -> KeyModifiers
fn not(self) -> KeyModifiers
Returns the complement of this set of flags.
§type Output = KeyModifiers
type Output = KeyModifiers
!
operator.source§impl Octal for KeyModifiers
impl Octal for KeyModifiers
source§impl Ord for KeyModifiers
impl Ord for KeyModifiers
source§fn cmp(&self, other: &KeyModifiers) -> Ordering
fn cmp(&self, other: &KeyModifiers) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for KeyModifiers
impl PartialEq for KeyModifiers
source§fn eq(&self, other: &KeyModifiers) -> bool
fn eq(&self, other: &KeyModifiers) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for KeyModifiers
impl PartialOrd for KeyModifiers
source§fn partial_cmp(&self, other: &KeyModifiers) -> Option<Ordering>
fn partial_cmp(&self, other: &KeyModifiers) -> 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 Sub for KeyModifiers
impl Sub for KeyModifiers
source§fn sub(self, other: KeyModifiers) -> KeyModifiers
fn sub(self, other: KeyModifiers) -> KeyModifiers
Returns the set difference of the two sets of flags.
§type Output = KeyModifiers
type Output = KeyModifiers
-
operator.source§impl SubAssign for KeyModifiers
impl SubAssign for KeyModifiers
source§fn sub_assign(&mut self, other: KeyModifiers)
fn sub_assign(&mut self, other: KeyModifiers)
Disables all flags enabled in the set.