Struct winit::keyboard::ModifiersState
source · pub struct ModifiersState(<ModifiersState as PublicFlags>::Internal);
Expand description
Represents the current state of the keyboard modifiers
Each flag represents a modifier and is set if this modifier is active.
Tuple Fields§
§0: <ModifiersState as PublicFlags>::Internal
Implementations§
source§impl ModifiersState
impl ModifiersState
sourcepub 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.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl ModifiersState
impl ModifiersState
sourcepub 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.
sourcepub 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.
source§impl ModifiersState
impl ModifiersState
sourcepub fn control_key(&self) -> bool
pub fn control_key(&self) -> bool
Returns true
if the control key is pressed.
Trait Implementations§
source§impl Binary for ModifiersState
impl Binary for ModifiersState
source§impl BitAnd for ModifiersState
impl BitAnd for ModifiersState
source§impl BitAndAssign for ModifiersState
impl BitAndAssign for ModifiersState
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for ModifiersState
impl BitOr for ModifiersState
source§fn bitor(self, other: ModifiersState) -> Self
fn bitor(self, other: ModifiersState) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = ModifiersState
type Output = ModifiersState
|
operator.source§impl BitOrAssign for ModifiersState
impl BitOrAssign for ModifiersState
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for ModifiersState
impl BitXor for ModifiersState
source§impl BitXorAssign for ModifiersState
impl BitXorAssign for ModifiersState
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for ModifiersState
impl Clone for ModifiersState
source§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 moresource§impl Debug for ModifiersState
impl Debug for ModifiersState
source§impl Default for ModifiersState
impl Default for ModifiersState
source§fn default() -> ModifiersState
fn default() -> ModifiersState
source§impl Extend<ModifiersState> for ModifiersState
impl Extend<ModifiersState> for ModifiersState
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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
)source§impl Flags for ModifiersState
impl Flags for ModifiersState
source§const FLAGS: &'static [Flag<ModifiersState>] = _
const FLAGS: &'static [Flag<ModifiersState>] = _
source§fn from_bits_retain(bits: u32) -> ModifiersState
fn from_bits_retain(bits: u32) -> ModifiersState
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§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.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§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.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl From<ModifiersState> for Modifiers
impl From<ModifiersState> for Modifiers
source§fn from(value: ModifiersState) -> Self
fn from(value: ModifiersState) -> Self
source§impl From<ModifiersState> for ModifiersState
impl From<ModifiersState> for ModifiersState
source§fn from(mods: ModifiersState) -> ModifiersState
fn from(mods: ModifiersState) -> ModifiersState
source§impl FromIterator<ModifiersState> for ModifiersState
impl FromIterator<ModifiersState> for ModifiersState
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for ModifiersState
impl Hash for ModifiersState
source§impl IntoIterator for ModifiersState
impl IntoIterator for ModifiersState
source§impl LowerHex for ModifiersState
impl LowerHex for ModifiersState
source§impl Not for ModifiersState
impl Not for ModifiersState
source§impl Octal for ModifiersState
impl Octal for ModifiersState
source§impl Ord for ModifiersState
impl Ord for ModifiersState
source§fn cmp(&self, other: &ModifiersState) -> Ordering
fn cmp(&self, other: &ModifiersState) -> 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 ModifiersState
impl PartialEq for ModifiersState
source§fn eq(&self, other: &ModifiersState) -> bool
fn eq(&self, other: &ModifiersState) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for ModifiersState
impl PartialOrd for ModifiersState
source§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 moresource§impl PublicFlags for ModifiersState
impl PublicFlags for ModifiersState
source§impl Sub for ModifiersState
impl Sub for ModifiersState
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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.source§impl SubAssign for ModifiersState
impl SubAssign for ModifiersState
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.
source§impl UpperHex for ModifiersState
impl UpperHex for ModifiersState
impl Copy for ModifiersState
impl Eq for ModifiersState
impl StructuralPartialEq for ModifiersState
Auto Trait Implementations§
impl Freeze for ModifiersState
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
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§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
.source§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
.source§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.source§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.