Struct esl::ContainerFlags
source · pub struct ContainerFlags { /* private fields */ }
Implementations
sourceimpl ContainerFlags
impl ContainerFlags
pub const ORGANIC: Self = _
pub const RESPAWN: 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
sourceimpl Binary for ContainerFlags
impl Binary for ContainerFlags
sourceimpl BitAnd<ContainerFlags> for ContainerFlags
impl BitAnd<ContainerFlags> for ContainerFlags
type Output = ContainerFlags
type Output = ContainerFlags
&
operator.sourceimpl BitAndAssign<ContainerFlags> for ContainerFlags
impl BitAndAssign<ContainerFlags> for ContainerFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ContainerFlags> for ContainerFlags
impl BitOr<ContainerFlags> for ContainerFlags
sourcefn bitor(self, other: ContainerFlags) -> Self
fn bitor(self, other: ContainerFlags) -> Self
Returns the union of the two sets of flags.
type Output = ContainerFlags
type Output = ContainerFlags
|
operator.sourceimpl BitOrAssign<ContainerFlags> for ContainerFlags
impl BitOrAssign<ContainerFlags> for ContainerFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ContainerFlags> for ContainerFlags
impl BitXor<ContainerFlags> for ContainerFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = ContainerFlags
type Output = ContainerFlags
^
operator.sourceimpl BitXorAssign<ContainerFlags> for ContainerFlags
impl BitXorAssign<ContainerFlags> for ContainerFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ContainerFlags
impl Clone for ContainerFlags
sourcefn clone(&self) -> ContainerFlags
fn clone(&self) -> ContainerFlags
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for ContainerFlags
impl Debug for ContainerFlags
sourceimpl Default for ContainerFlags
impl Default for ContainerFlags
sourcefn default() -> ContainerFlags
fn default() -> ContainerFlags
sourceimpl<'de> Deserialize<'de> for ContainerFlags
impl<'de> Deserialize<'de> for ContainerFlags
sourcefn 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>,
sourceimpl Display for ContainerFlags
impl Display for ContainerFlags
sourceimpl Extend<ContainerFlags> for ContainerFlags
impl Extend<ContainerFlags> for ContainerFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl From<ContainerFlags> for Field
impl From<ContainerFlags> for Field
sourcefn from(v: ContainerFlags) -> Self
fn from(v: ContainerFlags) -> Self
sourceimpl FromIterator<ContainerFlags> for ContainerFlags
impl FromIterator<ContainerFlags> for ContainerFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl FromStr for ContainerFlags
impl FromStr for ContainerFlags
sourceimpl Hash for ContainerFlags
impl Hash for ContainerFlags
sourceimpl LowerHex for ContainerFlags
impl LowerHex for ContainerFlags
sourceimpl Not for ContainerFlags
impl Not for ContainerFlags
type Output = ContainerFlags
type Output = ContainerFlags
!
operator.sourceimpl Octal for ContainerFlags
impl Octal for ContainerFlags
sourceimpl Ord for ContainerFlags
impl Ord for ContainerFlags
sourcefn cmp(&self, other: &ContainerFlags) -> Ordering
fn cmp(&self, other: &ContainerFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
sourceimpl PartialEq<ContainerFlags> for ContainerFlags
impl PartialEq<ContainerFlags> for ContainerFlags
sourcefn eq(&self, other: &ContainerFlags) -> bool
fn eq(&self, other: &ContainerFlags) -> bool
sourceimpl PartialOrd<ContainerFlags> for ContainerFlags
impl PartialOrd<ContainerFlags> for ContainerFlags
sourcefn partial_cmp(&self, other: &ContainerFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ContainerFlags) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Serialize for ContainerFlags
impl Serialize for ContainerFlags
sourceimpl Sub<ContainerFlags> for ContainerFlags
impl Sub<ContainerFlags> for ContainerFlags
type Output = ContainerFlags
type Output = ContainerFlags
-
operator.sourceimpl SubAssign<ContainerFlags> for ContainerFlags
impl SubAssign<ContainerFlags> for ContainerFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.