Struct zng_var::VarCapability
source · pub struct VarCapability(/* private fields */);
Expand description
Kinds of interactions allowed by a Var<T>
in the current update.
You can get the current capabilities of a var by using the AnyVar::capabilities
method.
Implementations§
source§impl VarCapability
impl VarCapability
sourcepub const NEW: Self = _
pub const NEW: Self = _
Var value can change.
If this is set the AnyVar::is_new
can be true
in some updates, a variable can NEW
even if it cannot MODIFY
, in this case the variable is a read-only wrapper on a read-write variable.
sourcepub const MODIFY: Self = _
pub const MODIFY: Self = _
Var can be modified.
If this is set Var::modify
always returns Ok
, if this is set NEW
is also set.
Note that modify requests from inside overridden animations can still be ignored, see AnyVar::modify_importance
.
sourcepub const CAPS_CHANGE: Self = _
pub const CAPS_CHANGE: Self = _
Var capabilities can change.
Var capabilities can only change in between app updates, just like the var value, but AnyVar::last_update
may not change when capability changes.
source§impl VarCapability
impl VarCapability
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 VarCapability
impl VarCapability
sourcepub const fn iter(&self) -> Iter<VarCapability>
pub const fn iter(&self) -> Iter<VarCapability>
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<VarCapability>
pub const fn iter_names(&self) -> IterNames<VarCapability>
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 VarCapability
impl VarCapability
sourcepub fn as_read_only(self) -> Self
pub fn as_read_only(self) -> Self
Remove only the MODIFY
flag without removing NEW
.
sourcepub fn is_always_read_only(self) -> bool
pub fn is_always_read_only(self) -> bool
If cannot MODIFY
and is not CAPS_CHANGE
.
sourcepub fn is_always_static(self) -> bool
pub fn is_always_static(self) -> bool
If cannot NEW
and is not CAPS_CHANGE
.
sourcepub fn can_modify(self) -> bool
pub fn can_modify(self) -> bool
Has the MODIFY
capability.
Trait Implementations§
source§impl Binary for VarCapability
impl Binary for VarCapability
source§impl BitAnd for VarCapability
impl BitAnd for VarCapability
source§impl BitAndAssign for VarCapability
impl BitAndAssign for VarCapability
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 VarCapability
impl BitOr for VarCapability
source§fn bitor(self, other: VarCapability) -> Self
fn bitor(self, other: VarCapability) -> Self
The bitwise or (|
) of the bits in two flags values.
source§type Output = VarCapability
type Output = VarCapability
|
operator.source§impl BitOrAssign for VarCapability
impl BitOrAssign for VarCapability
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 VarCapability
impl BitXor for VarCapability
source§impl BitXorAssign for VarCapability
impl BitXorAssign for VarCapability
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 VarCapability
impl Clone for VarCapability
source§fn clone(&self) -> VarCapability
fn clone(&self) -> VarCapability
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for VarCapability
impl Debug for VarCapability
source§impl Extend<VarCapability> for VarCapability
impl Extend<VarCapability> for VarCapability
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 VarCapability
impl Flags for VarCapability
source§const FLAGS: &'static [Flag<VarCapability>] = _
const FLAGS: &'static [Flag<VarCapability>] = _
source§fn from_bits_retain(bits: u8) -> VarCapability
fn from_bits_retain(bits: u8) -> VarCapability
§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<VarCapability> for VarCapability
impl FromIterator<VarCapability> for VarCapability
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 VarCapability
impl Hash for VarCapability
source§impl IntoIterator for VarCapability
impl IntoIterator for VarCapability
source§impl LowerHex for VarCapability
impl LowerHex for VarCapability
source§impl Not for VarCapability
impl Not for VarCapability
source§impl Octal for VarCapability
impl Octal for VarCapability
source§impl PartialEq for VarCapability
impl PartialEq for VarCapability
source§impl PublicFlags for VarCapability
impl PublicFlags for VarCapability
source§impl Sub for VarCapability
impl Sub for VarCapability
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 = VarCapability
type Output = VarCapability
-
operator.source§impl SubAssign for VarCapability
impl SubAssign for VarCapability
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 VarCapability
impl UpperHex for VarCapability
impl Copy for VarCapability
impl Eq for VarCapability
impl StructuralPartialEq for VarCapability
Auto Trait Implementations§
impl Freeze for VarCapability
impl RefUnwindSafe for VarCapability
impl Send for VarCapability
impl Sync for VarCapability
impl Unpin for VarCapability
impl UnwindSafe for VarCapability
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