pub struct SystemStateFlags(/* private fields */);
Expand description
Bitflags representing system states and requirements.
Implementations§
Source§impl SystemStateFlags
impl SystemStateFlags
Sourcepub const NON_SEND: SystemStateFlags
pub const NON_SEND: SystemStateFlags
Set if system cannot be sent across threads
Sourcepub const EXCLUSIVE: SystemStateFlags
pub const EXCLUSIVE: SystemStateFlags
Set if system requires exclusive World access
Sourcepub const DEFERRED: SystemStateFlags
pub const DEFERRED: SystemStateFlags
Set if system has deferred buffers.
Source§impl SystemStateFlags
impl SystemStateFlags
Sourcepub const fn empty() -> SystemStateFlags
pub const fn empty() -> SystemStateFlags
Get a flags value with all bits unset.
Sourcepub const fn all() -> SystemStateFlags
pub const fn all() -> SystemStateFlags
Get a flags value with all known bits set.
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<SystemStateFlags>
pub const fn from_bits(bits: u8) -> Option<SystemStateFlags>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u8) -> SystemStateFlags
pub const fn from_bits_truncate(bits: u8) -> SystemStateFlags
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u8) -> SystemStateFlags
pub const fn from_bits_retain(bits: u8) -> SystemStateFlags
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<SystemStateFlags>
pub fn from_name(name: &str) -> Option<SystemStateFlags>
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: SystemStateFlags) -> bool
pub const fn intersects(&self, other: SystemStateFlags) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: SystemStateFlags) -> bool
pub const fn contains(&self, other: SystemStateFlags) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn insert(&mut self, other: SystemStateFlags)
pub fn insert(&mut self, other: SystemStateFlags)
The bitwise or (|
) of the bits in two flags values.
Sourcepub fn remove(&mut self, other: SystemStateFlags)
pub fn remove(&mut self, other: SystemStateFlags)
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: SystemStateFlags)
pub fn toggle(&mut self, other: SystemStateFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: SystemStateFlags, value: bool)
pub fn set(&mut self, other: SystemStateFlags, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: SystemStateFlags) -> SystemStateFlags
pub const fn intersection(self, other: SystemStateFlags) -> SystemStateFlags
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: SystemStateFlags) -> SystemStateFlags
pub const fn union(self, other: SystemStateFlags) -> SystemStateFlags
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: SystemStateFlags) -> SystemStateFlags
pub const fn difference(self, other: SystemStateFlags) -> SystemStateFlags
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: SystemStateFlags,
) -> SystemStateFlags
pub const fn symmetric_difference( self, other: SystemStateFlags, ) -> SystemStateFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> SystemStateFlags
pub const fn complement(self) -> SystemStateFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl SystemStateFlags
impl SystemStateFlags
Sourcepub const fn iter(&self) -> Iter<SystemStateFlags> ⓘ
pub const fn iter(&self) -> Iter<SystemStateFlags> ⓘ
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<SystemStateFlags> ⓘ
pub const fn iter_names(&self) -> IterNames<SystemStateFlags> ⓘ
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 SystemStateFlags
impl Binary for SystemStateFlags
Source§impl BitAnd for SystemStateFlags
impl BitAnd for SystemStateFlags
Source§fn bitand(self, other: SystemStateFlags) -> SystemStateFlags
fn bitand(self, other: SystemStateFlags) -> SystemStateFlags
The bitwise and (&
) of the bits in two flags values.
Source§type Output = SystemStateFlags
type Output = SystemStateFlags
&
operator.Source§impl BitAndAssign for SystemStateFlags
impl BitAndAssign for SystemStateFlags
Source§fn bitand_assign(&mut self, other: SystemStateFlags)
fn bitand_assign(&mut self, other: SystemStateFlags)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOr for SystemStateFlags
impl BitOr for SystemStateFlags
Source§fn bitor(self, other: SystemStateFlags) -> SystemStateFlags
fn bitor(self, other: SystemStateFlags) -> SystemStateFlags
The bitwise or (|
) of the bits in two flags values.
Source§type Output = SystemStateFlags
type Output = SystemStateFlags
|
operator.Source§impl BitOrAssign for SystemStateFlags
impl BitOrAssign for SystemStateFlags
Source§fn bitor_assign(&mut self, other: SystemStateFlags)
fn bitor_assign(&mut self, other: SystemStateFlags)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXor for SystemStateFlags
impl BitXor for SystemStateFlags
Source§fn bitxor(self, other: SystemStateFlags) -> SystemStateFlags
fn bitxor(self, other: SystemStateFlags) -> SystemStateFlags
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§type Output = SystemStateFlags
type Output = SystemStateFlags
^
operator.Source§impl BitXorAssign for SystemStateFlags
impl BitXorAssign for SystemStateFlags
Source§fn bitxor_assign(&mut self, other: SystemStateFlags)
fn bitxor_assign(&mut self, other: SystemStateFlags)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Clone for SystemStateFlags
impl Clone for SystemStateFlags
Source§fn clone(&self) -> SystemStateFlags
fn clone(&self) -> SystemStateFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Extend<SystemStateFlags> for SystemStateFlags
impl Extend<SystemStateFlags> for SystemStateFlags
Source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = SystemStateFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = SystemStateFlags>,
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 SystemStateFlags
impl Flags for SystemStateFlags
Source§const FLAGS: &'static [Flag<SystemStateFlags>]
const FLAGS: &'static [Flag<SystemStateFlags>]
Source§fn from_bits_retain(bits: u8) -> SystemStateFlags
fn from_bits_retain(bits: u8) -> SystemStateFlags
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.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 FromIterator<SystemStateFlags> for SystemStateFlags
impl FromIterator<SystemStateFlags> for SystemStateFlags
Source§fn from_iter<T>(iterator: T) -> SystemStateFlagswhere
T: IntoIterator<Item = SystemStateFlags>,
fn from_iter<T>(iterator: T) -> SystemStateFlagswhere
T: IntoIterator<Item = SystemStateFlags>,
The bitwise or (|
) of the bits in each flags value.
Source§impl Hash for SystemStateFlags
impl Hash for SystemStateFlags
Source§impl IntoIterator for SystemStateFlags
impl IntoIterator for SystemStateFlags
Source§type Item = SystemStateFlags
type Item = SystemStateFlags
Source§type IntoIter = Iter<SystemStateFlags>
type IntoIter = Iter<SystemStateFlags>
Source§fn into_iter(self) -> <SystemStateFlags as IntoIterator>::IntoIter
fn into_iter(self) -> <SystemStateFlags as IntoIterator>::IntoIter
Source§impl LowerHex for SystemStateFlags
impl LowerHex for SystemStateFlags
Source§impl Not for SystemStateFlags
impl Not for SystemStateFlags
Source§fn not(self) -> SystemStateFlags
fn not(self) -> SystemStateFlags
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§type Output = SystemStateFlags
type Output = SystemStateFlags
!
operator.Source§impl Octal for SystemStateFlags
impl Octal for SystemStateFlags
Source§impl PartialEq for SystemStateFlags
impl PartialEq for SystemStateFlags
Source§impl Sub for SystemStateFlags
impl Sub for SystemStateFlags
Source§fn sub(self, other: SystemStateFlags) -> SystemStateFlags
fn sub(self, other: SystemStateFlags) -> SystemStateFlags
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 = SystemStateFlags
type Output = SystemStateFlags
-
operator.Source§impl SubAssign for SystemStateFlags
impl SubAssign for SystemStateFlags
Source§fn sub_assign(&mut self, other: SystemStateFlags)
fn sub_assign(&mut self, other: SystemStateFlags)
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 SystemStateFlags
impl UpperHex for SystemStateFlags
impl Copy for SystemStateFlags
impl Eq for SystemStateFlags
impl StructuralPartialEq for SystemStateFlags
Auto Trait Implementations§
impl Freeze for SystemStateFlags
impl RefUnwindSafe for SystemStateFlags
impl Send for SystemStateFlags
impl Sync for SystemStateFlags
impl Unpin for SystemStateFlags
impl UnwindSafe for SystemStateFlags
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.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§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>
, which can then be
downcast
into Box<dyn 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>
, which 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.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.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§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