pub struct ShortcutActionFlags(/* private fields */);
Expand description
List of flags that can be passed to action activation.
More flags may be added in the future.
Implementations§
source§impl ShortcutActionFlags
impl ShortcutActionFlags
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 ShortcutActionFlags
impl ShortcutActionFlags
sourcepub const fn iter(&self) -> Iter<ShortcutActionFlags>
pub const fn iter(&self) -> Iter<ShortcutActionFlags>
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<ShortcutActionFlags>
pub const fn iter_names(&self) -> IterNames<ShortcutActionFlags>
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.
Trait Implementations§
source§impl Binary for ShortcutActionFlags
impl Binary for ShortcutActionFlags
source§impl BitAnd for ShortcutActionFlags
impl BitAnd for ShortcutActionFlags
source§impl BitAndAssign for ShortcutActionFlags
impl BitAndAssign for ShortcutActionFlags
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 ShortcutActionFlags
impl BitOr for ShortcutActionFlags
source§fn bitor(self, other: ShortcutActionFlags) -> Self
fn bitor(self, other: ShortcutActionFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
source§type Output = ShortcutActionFlags
type Output = ShortcutActionFlags
|
operator.source§impl BitOrAssign for ShortcutActionFlags
impl BitOrAssign for ShortcutActionFlags
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 ShortcutActionFlags
impl BitXor for ShortcutActionFlags
source§impl BitXorAssign for ShortcutActionFlags
impl BitXorAssign for ShortcutActionFlags
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 ShortcutActionFlags
impl Clone for ShortcutActionFlags
source§fn clone(&self) -> ShortcutActionFlags
fn clone(&self) -> ShortcutActionFlags
1.6.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ShortcutActionFlags
impl Debug for ShortcutActionFlags
source§impl Extend<ShortcutActionFlags> for ShortcutActionFlags
impl Extend<ShortcutActionFlags> for ShortcutActionFlags
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 ShortcutActionFlags
impl Flags for ShortcutActionFlags
source§const FLAGS: &'static [Flag<ShortcutActionFlags>] = _
const FLAGS: &'static [Flag<ShortcutActionFlags>] = _
source§fn from_bits_retain(bits: u32) -> ShortcutActionFlags
fn from_bits_retain(bits: u32) -> ShortcutActionFlags
§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 From<ShortcutActionFlags> for Value
impl From<ShortcutActionFlags> for Value
source§fn from(v: ShortcutActionFlags) -> Self
fn from(v: ShortcutActionFlags) -> Self
source§impl FromIterator<ShortcutActionFlags> for ShortcutActionFlags
impl FromIterator<ShortcutActionFlags> for ShortcutActionFlags
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<'a> FromValue<'a> for ShortcutActionFlags
impl<'a> FromValue<'a> for ShortcutActionFlags
source§type Checker = GenericValueTypeChecker<ShortcutActionFlags>
type Checker = GenericValueTypeChecker<ShortcutActionFlags>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for ShortcutActionFlags
impl HasParamSpec for ShortcutActionFlags
type ParamSpec = ParamSpecFlags
source§type SetValue = ShortcutActionFlags
type SetValue = ShortcutActionFlags
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, ShortcutActionFlags>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for ShortcutActionFlags
impl Hash for ShortcutActionFlags
source§impl IntoIterator for ShortcutActionFlags
impl IntoIterator for ShortcutActionFlags
source§impl LowerHex for ShortcutActionFlags
impl LowerHex for ShortcutActionFlags
source§impl Not for ShortcutActionFlags
impl Not for ShortcutActionFlags
source§impl Octal for ShortcutActionFlags
impl Octal for ShortcutActionFlags
source§impl PartialEq for ShortcutActionFlags
impl PartialEq for ShortcutActionFlags
source§impl PublicFlags for ShortcutActionFlags
impl PublicFlags for ShortcutActionFlags
source§impl StaticType for ShortcutActionFlags
impl StaticType for ShortcutActionFlags
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub for ShortcutActionFlags
impl Sub for ShortcutActionFlags
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 = ShortcutActionFlags
type Output = ShortcutActionFlags
-
operator.source§impl SubAssign for ShortcutActionFlags
impl SubAssign for ShortcutActionFlags
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 ToValue for ShortcutActionFlags
impl ToValue for ShortcutActionFlags
source§impl UpperHex for ShortcutActionFlags
impl UpperHex for ShortcutActionFlags
source§impl ValueType for ShortcutActionFlags
impl ValueType for ShortcutActionFlags
source§type Type = ShortcutActionFlags
type Type = ShortcutActionFlags
Type
from. Read moreimpl Copy for ShortcutActionFlags
impl Eq for ShortcutActionFlags
impl StructuralPartialEq for ShortcutActionFlags
Auto Trait Implementations§
impl Freeze for ShortcutActionFlags
impl RefUnwindSafe for ShortcutActionFlags
impl Send for ShortcutActionFlags
impl Sync for ShortcutActionFlags
impl Unpin for ShortcutActionFlags
impl UnwindSafe for ShortcutActionFlags
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> 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
)source§impl<T> IntoClosureReturnValue for T
impl<T> IntoClosureReturnValue for T
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere
T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere
T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for T
impl<T> ToSendValue for T
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.