Struct zng_app::shortcut::ModifiersState
source · 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§
source§impl ModifiersState
impl ModifiersState
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> 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 is_only(self, part: ModifiersState) -> bool
pub fn is_only(self, part: ModifiersState) -> bool
Returns true
if only any flag in part
is pressed.
sourcepub fn is_only_shift(self) -> bool
pub fn is_only_shift(self) -> bool
Returns true
if only any shift key is pressed.
sourcepub fn is_only_ctrl(self) -> bool
pub fn is_only_ctrl(self) -> bool
Returns true
if only any control key is pressed.
sourcepub fn is_only_alt(self) -> bool
pub fn is_only_alt(self) -> bool
Returns true
if only any alt key is pressed.
sourcepub fn is_only_logo(self) -> bool
pub fn is_only_logo(self) -> bool
Returns true
if only any logo key is pressed.
sourcepub fn take(&mut self, part: ModifiersState) -> bool
pub fn take(&mut self, part: ModifiersState) -> bool
Removes part
and returns if it was removed.
sourcepub fn take_shift(&mut self) -> bool
pub fn take_shift(&mut self) -> bool
Removes SHIFT
and returns if it was removed.
sourcepub fn ambit(self) -> Self
pub fn ambit(self) -> Self
Returns modifiers that set both left and right flags if any side is set in self
.
sourcepub fn into_shift(self) -> Self
pub fn into_shift(self) -> Self
Returns only the shift flags in self
.
sourcepub fn from_code(code: KeyCode) -> ModifiersState
pub fn from_code(code: KeyCode) -> ModifiersState
Modifier from code
, returns empty if the key is not a modifier.
sourcepub fn from_key(key: Key) -> ModifiersState
pub fn from_key(key: Key) -> ModifiersState
Modifier from key
, returns empty if the key is not a modifier.
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.
source§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<'de> Deserialize<'de> for ModifiersState
impl<'de> Deserialize<'de> for ModifiersState
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
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: u8) -> ModifiersState
fn from_bits_retain(bits: u8) -> 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.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 PartialEq for ModifiersState
impl PartialEq for ModifiersState
source§impl PublicFlags for ModifiersState
impl PublicFlags for ModifiersState
source§impl Serialize for ModifiersState
impl Serialize 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.
source§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> AnyVarValue for Twhere
T: VarValue,
impl<T> AnyVarValue for Twhere
T: VarValue,
source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
dyn Any
methods.source§fn clone_boxed(&self) -> Box<dyn AnyVarValue>
fn clone_boxed(&self) -> Box<dyn AnyVarValue>
source§fn clone_boxed_var(&self) -> Box<dyn AnyVar>
fn clone_boxed_var(&self) -> Box<dyn AnyVar>
LocalVar<Self>
.source§fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool
fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool
self
equals other
.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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§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>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more