pub struct KittyKeyboardFlags { /* private fields */ }
Implementations
sourceimpl KittyKeyboardFlags
impl KittyKeyboardFlags
pub const NONE: Self = _
pub const DISAMBIGUATE_ESCAPE_CODES: Self = _
pub const REPORT_EVENT_TYPES: Self = _
pub const REPORT_ALTERNATE_KEYS: Self = _
pub const REPORT_ALL_KEYS_AS_ESCAPE_CODES: Self = _
pub const REPORT_ASSOCIATED_TEXT: Self = _
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 KittyKeyboardFlags
impl Binary for KittyKeyboardFlags
sourceimpl BitAnd<KittyKeyboardFlags> for KittyKeyboardFlags
impl BitAnd<KittyKeyboardFlags> for KittyKeyboardFlags
type Output = KittyKeyboardFlags
type Output = KittyKeyboardFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<KittyKeyboardFlags> for KittyKeyboardFlags
impl BitAndAssign<KittyKeyboardFlags> for KittyKeyboardFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<KittyKeyboardFlags> for KittyKeyboardFlags
impl BitOr<KittyKeyboardFlags> for KittyKeyboardFlags
sourcefn bitor(self, other: KittyKeyboardFlags) -> Self
fn bitor(self, other: KittyKeyboardFlags) -> Self
Returns the union of the two sets of flags.
type Output = KittyKeyboardFlags
type Output = KittyKeyboardFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<KittyKeyboardFlags> for KittyKeyboardFlags
impl BitOrAssign<KittyKeyboardFlags> for KittyKeyboardFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<KittyKeyboardFlags> for KittyKeyboardFlags
impl BitXor<KittyKeyboardFlags> for KittyKeyboardFlags
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 = KittyKeyboardFlags
type Output = KittyKeyboardFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<KittyKeyboardFlags> for KittyKeyboardFlags
impl BitXorAssign<KittyKeyboardFlags> for KittyKeyboardFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for KittyKeyboardFlags
impl Clone for KittyKeyboardFlags
sourcefn clone(&self) -> KittyKeyboardFlags
fn clone(&self) -> KittyKeyboardFlags
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 KittyKeyboardFlags
impl Debug for KittyKeyboardFlags
sourceimpl Extend<KittyKeyboardFlags> for KittyKeyboardFlags
impl Extend<KittyKeyboardFlags> for KittyKeyboardFlags
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<KittyKeyboardFlags> for KittyKeyboardFlags
impl FromIterator<KittyKeyboardFlags> for KittyKeyboardFlags
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 KittyKeyboardFlags
impl Hash for KittyKeyboardFlags
sourceimpl LowerHex for KittyKeyboardFlags
impl LowerHex for KittyKeyboardFlags
sourceimpl Not for KittyKeyboardFlags
impl Not for KittyKeyboardFlags
type Output = KittyKeyboardFlags
type Output = KittyKeyboardFlags
The resulting type after applying the !
operator.
sourceimpl Octal for KittyKeyboardFlags
impl Octal for KittyKeyboardFlags
sourceimpl Ord for KittyKeyboardFlags
impl Ord for KittyKeyboardFlags
sourcefn cmp(&self, other: &KittyKeyboardFlags) -> Ordering
fn cmp(&self, other: &KittyKeyboardFlags) -> 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<KittyKeyboardFlags> for KittyKeyboardFlags
impl PartialEq<KittyKeyboardFlags> for KittyKeyboardFlags
sourcefn eq(&self, other: &KittyKeyboardFlags) -> bool
fn eq(&self, other: &KittyKeyboardFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &KittyKeyboardFlags) -> bool
fn ne(&self, other: &KittyKeyboardFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<KittyKeyboardFlags> for KittyKeyboardFlags
impl PartialOrd<KittyKeyboardFlags> for KittyKeyboardFlags
sourcefn partial_cmp(&self, other: &KittyKeyboardFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &KittyKeyboardFlags) -> 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 Sub<KittyKeyboardFlags> for KittyKeyboardFlags
impl Sub<KittyKeyboardFlags> for KittyKeyboardFlags
type Output = KittyKeyboardFlags
type Output = KittyKeyboardFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<KittyKeyboardFlags> for KittyKeyboardFlags
impl SubAssign<KittyKeyboardFlags> for KittyKeyboardFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for KittyKeyboardFlags
impl UpperHex for KittyKeyboardFlags
impl Copy for KittyKeyboardFlags
impl Eq for KittyKeyboardFlags
impl StructuralEq for KittyKeyboardFlags
impl StructuralPartialEq for KittyKeyboardFlags
Auto Trait Implementations
impl RefUnwindSafe for KittyKeyboardFlags
impl Send for KittyKeyboardFlags
impl Sync for KittyKeyboardFlags
impl Unpin for KittyKeyboardFlags
impl UnwindSafe for KittyKeyboardFlags
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