Struct dioxus_mobile::wry::application::keyboard::ModifiersState [−]
pub struct ModifiersState { /* fields omitted */ }
Expand description
Represents the current state of the keyboard modifiers
Each flag represents a modifier and is set if this modifier is active.
Implementations
impl ModifiersState
impl ModifiersState
impl ModifiersState
impl ModifiersState
pub const SHIFT: ModifiersState
pub const SHIFT: ModifiersState
The “shift” key.
pub const CONTROL: ModifiersState
pub const CONTROL: ModifiersState
The “control” key.
pub const ALT: ModifiersState
pub const ALT: ModifiersState
The “alt” key.
pub const SUPER: ModifiersState
pub const SUPER: ModifiersState
This is the “windows” key on PC and “command” key on Mac.
pub const fn empty() -> ModifiersState
pub const fn empty() -> ModifiersState
Returns an empty set of flags.
pub const fn all() -> ModifiersState
pub const fn all() -> ModifiersState
Returns the set containing all flags.
pub const fn from_bits(bits: u32) -> Option<ModifiersState>
pub const fn from_bits(bits: u32) -> Option<ModifiersState>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u32) -> ModifiersState
pub const fn from_bits_truncate(bits: u32) -> ModifiersState
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> ModifiersState
pub const unsafe fn from_bits_unchecked(bits: u32) -> ModifiersState
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.
pub const fn intersects(&self, other: ModifiersState) -> bool
pub const fn intersects(&self, other: ModifiersState) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: ModifiersState) -> bool
pub const fn contains(&self, other: ModifiersState) -> bool
Returns true
if all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: ModifiersState)
pub fn insert(&mut self, other: ModifiersState)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: ModifiersState)
pub fn remove(&mut self, other: ModifiersState)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: ModifiersState)
pub fn toggle(&mut self, other: ModifiersState)
Toggles the specified flags in-place.
pub fn set(&mut self, other: ModifiersState, value: bool)
pub fn set(&mut self, other: ModifiersState, value: bool)
Inserts or removes the specified flags depending on the passed value.
pub const fn intersection(self, other: ModifiersState) -> ModifiersState
pub const fn intersection(self, other: ModifiersState) -> ModifiersState
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
.
pub const fn union(self, other: ModifiersState) -> ModifiersState
pub const fn union(self, other: ModifiersState) -> ModifiersState
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
.
pub const fn difference(self, other: ModifiersState) -> ModifiersState
pub const fn difference(self, other: ModifiersState) -> ModifiersState
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
.
pub const fn symmetric_difference(self, other: ModifiersState) -> ModifiersState
pub const fn symmetric_difference(self, other: ModifiersState) -> ModifiersState
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
.
pub const fn complement(self) -> ModifiersState
pub const fn complement(self) -> ModifiersState
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
impl Binary for ModifiersState
impl Binary for ModifiersState
impl BitAnd<ModifiersState> for ModifiersState
impl BitAnd<ModifiersState> for ModifiersState
pub fn bitand(self, other: ModifiersState) -> ModifiersState
pub fn bitand(self, other: ModifiersState) -> ModifiersState
Returns the intersection between the two sets of flags.
type Output = ModifiersState
type Output = ModifiersState
The resulting type after applying the &
operator.
impl BitAndAssign<ModifiersState> for ModifiersState
impl BitAndAssign<ModifiersState> for ModifiersState
pub fn bitand_assign(&mut self, other: ModifiersState)
pub fn bitand_assign(&mut self, other: ModifiersState)
Disables all flags disabled in the set.
impl BitOr<ModifiersState> for ModifiersState
impl BitOr<ModifiersState> for ModifiersState
pub fn bitor(self, other: ModifiersState) -> ModifiersState
pub fn bitor(self, other: ModifiersState) -> ModifiersState
Returns the union of the two sets of flags.
type Output = ModifiersState
type Output = ModifiersState
The resulting type after applying the |
operator.
impl BitOrAssign<ModifiersState> for ModifiersState
impl BitOrAssign<ModifiersState> for ModifiersState
pub fn bitor_assign(&mut self, other: ModifiersState)
pub fn bitor_assign(&mut self, other: ModifiersState)
Adds the set of flags.
impl BitXor<ModifiersState> for ModifiersState
impl BitXor<ModifiersState> for ModifiersState
pub fn bitxor(self, other: ModifiersState) -> ModifiersState
pub fn bitxor(self, other: ModifiersState) -> ModifiersState
Returns the left flags, but with all the right flags toggled.
type Output = ModifiersState
type Output = ModifiersState
The resulting type after applying the ^
operator.
impl BitXorAssign<ModifiersState> for ModifiersState
impl BitXorAssign<ModifiersState> for ModifiersState
pub fn bitxor_assign(&mut self, other: ModifiersState)
pub fn bitxor_assign(&mut self, other: ModifiersState)
Toggles the set of flags.
impl Clone for ModifiersState
impl Clone for ModifiersState
pub fn clone(&self) -> ModifiersState
pub fn clone(&self) -> ModifiersState
Returns a copy of the value. Read more
Performs copy-assignment from source
. Read more
impl Debug for ModifiersState
impl Debug for ModifiersState
impl Default for ModifiersState
impl Default for ModifiersState
pub fn default() -> ModifiersState
pub fn default() -> ModifiersState
Returns the “default value” for a type. Read more
impl<'de> Deserialize<'de> for ModifiersState
impl<'de> Deserialize<'de> for ModifiersState
pub fn deserialize<D>(
deserializer: D
) -> Result<ModifiersState, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<ModifiersState, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Extend<ModifiersState> for ModifiersState
impl Extend<ModifiersState> for ModifiersState
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = ModifiersState>,
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = ModifiersState>,
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl From<RawMods> for ModifiersState
impl From<RawMods> for ModifiersState
pub fn from(src: RawMods) -> ModifiersState
pub fn from(src: RawMods) -> ModifiersState
Performs the conversion.
impl From<SysMods> for ModifiersState
impl From<SysMods> for ModifiersState
pub fn from(src: SysMods) -> ModifiersState
pub fn from(src: SysMods) -> ModifiersState
Performs the conversion.
impl FromIterator<ModifiersState> for ModifiersState
impl FromIterator<ModifiersState> for ModifiersState
pub fn from_iter<T>(iterator: T) -> ModifiersState where
T: IntoIterator<Item = ModifiersState>,
pub fn from_iter<T>(iterator: T) -> ModifiersState where
T: IntoIterator<Item = ModifiersState>,
Creates a value from an iterator. Read more
impl Hash for ModifiersState
impl Hash for ModifiersState
impl LowerHex for ModifiersState
impl LowerHex for ModifiersState
impl Not for ModifiersState
impl Not for ModifiersState
pub fn not(self) -> ModifiersState
pub fn not(self) -> ModifiersState
Returns the complement of this set of flags.
type Output = ModifiersState
type Output = ModifiersState
The resulting type after applying the !
operator.
impl Octal for ModifiersState
impl Octal for ModifiersState
impl Ord for ModifiersState
impl Ord for ModifiersState
pub fn cmp(&self, other: &ModifiersState) -> Ordering
pub fn cmp(&self, other: &ModifiersState) -> Ordering
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
impl PartialEq<ModifiersState> for ModifiersState
impl PartialEq<ModifiersState> for ModifiersState
pub fn eq(&self, other: &ModifiersState) -> bool
pub fn eq(&self, other: &ModifiersState) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
pub fn ne(&self, other: &ModifiersState) -> bool
pub fn ne(&self, other: &ModifiersState) -> bool
This method tests for !=
.
impl PartialOrd<ModifiersState> for ModifiersState
impl PartialOrd<ModifiersState> for ModifiersState
pub fn partial_cmp(&self, other: &ModifiersState) -> Option<Ordering>
pub fn partial_cmp(&self, other: &ModifiersState) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
impl Serialize for ModifiersState
impl Serialize for ModifiersState
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl Sub<ModifiersState> for ModifiersState
impl Sub<ModifiersState> for ModifiersState
pub fn sub(self, other: ModifiersState) -> ModifiersState
pub fn sub(self, other: ModifiersState) -> ModifiersState
Returns the set difference of the two sets of flags.
type Output = ModifiersState
type Output = ModifiersState
The resulting type after applying the -
operator.
impl SubAssign<ModifiersState> for ModifiersState
impl SubAssign<ModifiersState> for ModifiersState
pub fn sub_assign(&mut self, other: ModifiersState)
pub fn sub_assign(&mut self, other: ModifiersState)
Disables all flags enabled in the set.
impl UpperHex for ModifiersState
impl UpperHex for ModifiersState
impl Copy for ModifiersState
impl Eq for ModifiersState
impl StructuralEq for ModifiersState
impl StructuralPartialEq for ModifiersState
Auto Trait Implementations
impl RefUnwindSafe for ModifiersState
impl Send for ModifiersState
impl Sync for ModifiersState
impl Unpin for ModifiersState
impl UnwindSafe for ModifiersState
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.