pub struct ActorFlags { /* private fields */ }
Implementations§
Source§impl ActorFlags
impl ActorFlags
pub const MAPPED: Self
pub const REALIZED: Self
pub const REACTIVE: Self
pub const VISIBLE: Self
pub const NO_LAYOUT: Self
Sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
§Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
Source§impl Binary for ActorFlags
impl Binary for ActorFlags
Source§impl BitAnd for ActorFlags
impl BitAnd for ActorFlags
Source§impl BitAndAssign for ActorFlags
impl BitAndAssign for ActorFlags
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
Source§impl BitOr for ActorFlags
impl BitOr for ActorFlags
Source§fn bitor(self, other: ActorFlags) -> Self
fn bitor(self, other: ActorFlags) -> Self
Returns the union of the two sets of flags.
Source§type Output = ActorFlags
type Output = ActorFlags
|
operator.Source§impl BitOrAssign for ActorFlags
impl BitOrAssign for ActorFlags
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
Source§impl BitXor for ActorFlags
impl BitXor for ActorFlags
Source§impl BitXorAssign for ActorFlags
impl BitXorAssign for ActorFlags
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
Source§impl Clone for ActorFlags
impl Clone for ActorFlags
Source§fn clone(&self) -> ActorFlags
fn clone(&self) -> ActorFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ActorFlags
impl Debug for ActorFlags
Source§impl Extend<ActorFlags> for ActorFlags
impl Extend<ActorFlags> for ActorFlags
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<ActorFlags> for ActorFlags
impl FromIterator<ActorFlags> for ActorFlags
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Source§impl<'a> FromValue<'a> for ActorFlags
impl<'a> FromValue<'a> for ActorFlags
Source§unsafe fn from_value(value: &Value) -> Self
unsafe fn from_value(value: &Value) -> Self
Source§impl<'a> FromValueOptional<'a> for ActorFlags
impl<'a> FromValueOptional<'a> for ActorFlags
Source§impl Hash for ActorFlags
impl Hash for ActorFlags
Source§impl LowerHex for ActorFlags
impl LowerHex for ActorFlags
Source§impl Not for ActorFlags
impl Not for ActorFlags
Source§impl Octal for ActorFlags
impl Octal for ActorFlags
Source§impl Ord for ActorFlags
impl Ord for ActorFlags
Source§fn cmp(&self, other: &ActorFlags) -> Ordering
fn cmp(&self, other: &ActorFlags) -> 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 ActorFlags
impl PartialEq for ActorFlags
Source§impl PartialOrd for ActorFlags
impl PartialOrd for ActorFlags
Source§impl SetValue for ActorFlags
impl SetValue for ActorFlags
Source§impl StaticType for ActorFlags
impl StaticType for ActorFlags
Source§fn static_type() -> Type
fn static_type() -> Type
Self
.Source§impl Sub for ActorFlags
impl Sub for ActorFlags
Source§impl SubAssign for ActorFlags
impl SubAssign for ActorFlags
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
Source§impl UpperHex for ActorFlags
impl UpperHex for ActorFlags
impl Copy for ActorFlags
impl Eq for ActorFlags
impl StructuralPartialEq for ActorFlags
Auto Trait Implementations§
impl Freeze for ActorFlags
impl RefUnwindSafe for ActorFlags
impl Send for ActorFlags
impl Sync for ActorFlags
impl Unpin for ActorFlags
impl UnwindSafe for ActorFlags
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§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
.