Struct kas::event::ModifiersState
pub struct ModifiersState(/* private fields */);
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
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.
§impl ModifiersState
impl ModifiersState
pub const fn empty() -> ModifiersState
pub const fn empty() -> ModifiersState
Get a flags value with all bits unset.
pub const fn all() -> ModifiersState
pub const fn all() -> ModifiersState
Get a flags value with all known bits set.
pub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
pub const fn from_bits(bits: u32) -> Option<ModifiersState>
pub const fn from_bits(bits: u32) -> Option<ModifiersState>
Convert from a bits value.
This method will return None
if any unknown bits are set.
pub const fn from_bits_truncate(bits: u32) -> ModifiersState
pub const fn from_bits_truncate(bits: u32) -> ModifiersState
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u32) -> ModifiersState
pub const fn from_bits_retain(bits: u32) -> ModifiersState
Convert from a bits value exactly.
pub fn from_name(name: &str) -> Option<ModifiersState>
pub fn from_name(name: &str) -> Option<ModifiersState>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
pub const fn intersects(&self, other: ModifiersState) -> bool
pub const fn intersects(&self, other: ModifiersState) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
pub const fn contains(&self, other: ModifiersState) -> bool
pub const fn contains(&self, other: ModifiersState) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
pub fn insert(&mut self, other: ModifiersState)
pub fn insert(&mut self, other: ModifiersState)
The bitwise or (|
) of the bits in two flags values.
pub fn remove(&mut self, other: ModifiersState)
pub fn remove(&mut self, other: ModifiersState)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
pub fn toggle(&mut self, other: ModifiersState)
pub fn toggle(&mut self, other: ModifiersState)
The bitwise exclusive-or (^
) of the bits in two flags values.
pub fn set(&mut self, other: ModifiersState, value: bool)
pub fn set(&mut self, other: ModifiersState, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
pub const fn intersection(self, other: ModifiersState) -> ModifiersState
pub const fn intersection(self, other: ModifiersState) -> ModifiersState
The bitwise and (&
) of the bits in two flags values.
pub const fn union(self, other: ModifiersState) -> ModifiersState
pub const fn union(self, other: ModifiersState) -> ModifiersState
The bitwise or (|
) of the bits in two flags values.
pub const fn difference(self, other: ModifiersState) -> ModifiersState
pub const fn difference(self, other: ModifiersState) -> ModifiersState
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
pub const fn symmetric_difference(self, other: ModifiersState) -> ModifiersState
pub const fn symmetric_difference(self, other: ModifiersState) -> ModifiersState
The bitwise exclusive-or (^
) of the bits in two flags values.
pub const fn complement(self) -> ModifiersState
pub const fn complement(self) -> ModifiersState
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§impl ModifiersState
impl ModifiersState
pub const fn iter(&self) -> Iter<ModifiersState>
pub const fn iter(&self) -> Iter<ModifiersState>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
pub const fn iter_names(&self) -> IterNames<ModifiersState>
pub const fn iter_names(&self) -> IterNames<ModifiersState>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
§impl ModifiersState
impl ModifiersState
Trait Implementations§
§impl Binary for ModifiersState
impl Binary for ModifiersState
§impl BitAnd for ModifiersState
impl BitAnd for ModifiersState
§fn bitand(self, other: ModifiersState) -> ModifiersState
fn bitand(self, other: ModifiersState) -> ModifiersState
The bitwise and (&
) of the bits in two flags values.
§type Output = ModifiersState
type Output = ModifiersState
&
operator.§impl BitAndAssign for ModifiersState
impl BitAndAssign for ModifiersState
§fn bitand_assign(&mut self, other: ModifiersState)
fn bitand_assign(&mut self, other: ModifiersState)
The bitwise and (&
) of the bits in two flags values.
§impl BitOr for ModifiersState
impl BitOr for ModifiersState
§fn bitor(self, other: ModifiersState) -> ModifiersState
fn bitor(self, other: ModifiersState) -> ModifiersState
The bitwise or (|
) of the bits in two flags values.
§type Output = ModifiersState
type Output = ModifiersState
|
operator.§impl BitOrAssign for ModifiersState
impl BitOrAssign for ModifiersState
§fn bitor_assign(&mut self, other: ModifiersState)
fn bitor_assign(&mut self, other: ModifiersState)
The bitwise or (|
) of the bits in two flags values.
§impl BitXor for ModifiersState
impl BitXor for ModifiersState
§fn bitxor(self, other: ModifiersState) -> ModifiersState
fn bitxor(self, other: ModifiersState) -> ModifiersState
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = ModifiersState
type Output = ModifiersState
^
operator.§impl BitXorAssign for ModifiersState
impl BitXorAssign for ModifiersState
§fn bitxor_assign(&mut self, other: ModifiersState)
fn bitxor_assign(&mut self, other: ModifiersState)
The bitwise exclusive-or (^
) of the bits in two flags values.
§impl Clone for ModifiersState
impl Clone for ModifiersState
§fn clone(&self) -> ModifiersState
fn clone(&self) -> ModifiersState
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ModifiersState
impl Debug for ModifiersState
§impl Default for ModifiersState
impl Default for ModifiersState
§fn default() -> ModifiersState
fn default() -> ModifiersState
§impl Extend<ModifiersState> for ModifiersState
impl Extend<ModifiersState> for ModifiersState
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ModifiersState>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ModifiersState>,
The bitwise or (|
) of the bits in each flags value.
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
)§impl Flags for ModifiersState
impl Flags for ModifiersState
§const FLAGS: &'static [Flag<ModifiersState>] = _
const FLAGS: &'static [Flag<ModifiersState>] = _
§fn from_bits_retain(bits: u32) -> ModifiersState
fn from_bits_retain(bits: u32) -> ModifiersState
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.§impl From<ModifiersState> for ModifiersState
impl From<ModifiersState> for ModifiersState
§fn from(mods: ModifiersState) -> ModifiersState
fn from(mods: ModifiersState) -> ModifiersState
§impl FromIterator<ModifiersState> for ModifiersState
impl FromIterator<ModifiersState> for ModifiersState
§fn from_iter<T>(iterator: T) -> ModifiersStatewhere
T: IntoIterator<Item = ModifiersState>,
fn from_iter<T>(iterator: T) -> ModifiersStatewhere
T: IntoIterator<Item = ModifiersState>,
The bitwise or (|
) of the bits in each flags value.
§impl Hash for ModifiersState
impl Hash for ModifiersState
§impl IntoIterator for ModifiersState
impl IntoIterator for ModifiersState
§type Item = ModifiersState
type Item = ModifiersState
§type IntoIter = Iter<ModifiersState>
type IntoIter = Iter<ModifiersState>
§fn into_iter(self) -> <ModifiersState as IntoIterator>::IntoIter
fn into_iter(self) -> <ModifiersState as IntoIterator>::IntoIter
§impl LowerHex for ModifiersState
impl LowerHex for ModifiersState
§impl Not for ModifiersState
impl Not for ModifiersState
§fn not(self) -> ModifiersState
fn not(self) -> ModifiersState
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = ModifiersState
type Output = ModifiersState
!
operator.§impl Octal for ModifiersState
impl Octal for ModifiersState
§impl Ord for ModifiersState
impl Ord for ModifiersState
§impl PartialEq for ModifiersState
impl PartialEq for ModifiersState
§fn eq(&self, other: &ModifiersState) -> bool
fn eq(&self, other: &ModifiersState) -> bool
self
and other
values to be equal, and is used
by ==
.§impl PartialOrd for ModifiersState
impl PartialOrd for ModifiersState
§fn partial_cmp(&self, other: &ModifiersState) -> Option<Ordering>
fn partial_cmp(&self, other: &ModifiersState) -> 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 more§impl Sub for ModifiersState
impl Sub for ModifiersState
§fn sub(self, other: ModifiersState) -> ModifiersState
fn sub(self, other: ModifiersState) -> ModifiersState
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = ModifiersState
type Output = ModifiersState
-
operator.§impl SubAssign for ModifiersState
impl SubAssign for ModifiersState
§fn sub_assign(&mut self, other: ModifiersState)
fn sub_assign(&mut self, other: ModifiersState)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
impl<S, T> CastApprox<T> for Swhere
T: ConvApprox<S>,
§fn try_cast_approx(self) -> Result<T, Error>
fn try_cast_approx(self) -> Result<T, Error>
§fn cast_approx(self) -> T
fn cast_approx(self) -> T
§impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,
§fn cast_trunc(self) -> T
fn cast_trunc(self) -> T
§fn cast_nearest(self) -> T
fn cast_nearest(self) -> T
§fn cast_floor(self) -> T
fn cast_floor(self) -> T
§fn try_cast_trunc(self) -> Result<T, Error>
fn try_cast_trunc(self) -> Result<T, Error>
§fn try_cast_nearest(self) -> Result<T, Error>
fn try_cast_nearest(self) -> Result<T, Error>
§fn try_cast_floor(self) -> Result<T, Error>
fn try_cast_floor(self) -> Result<T, Error>
§fn try_cast_ceil(self) -> Result<T, Error>
fn try_cast_ceil(self) -> Result<T, Error>
§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.