Struct esl::EffectFlags
source · pub struct EffectFlags(/* private fields */);
Implementations§
source§impl EffectFlags
impl EffectFlags
pub const SPELLMAKING: Self = _
pub const ENCHANTING: Self = _
pub const LIGHT_NEGATIVE: Self = _
source§impl EffectFlags
impl EffectFlags
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 EffectFlags
impl EffectFlags
sourcepub const fn iter(&self) -> Iter<EffectFlags>
pub const fn iter(&self) -> Iter<EffectFlags>
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<EffectFlags>
pub const fn iter_names(&self) -> IterNames<EffectFlags>
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 EffectFlags
impl Binary for EffectFlags
source§impl BitAnd for EffectFlags
impl BitAnd for EffectFlags
source§impl BitAndAssign for EffectFlags
impl BitAndAssign for EffectFlags
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 EffectFlags
impl BitOr for EffectFlags
source§fn bitor(self, other: EffectFlags) -> Self
fn bitor(self, other: EffectFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = EffectFlags
type Output = EffectFlags
|
operator.source§impl BitOrAssign for EffectFlags
impl BitOrAssign for EffectFlags
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 EffectFlags
impl BitXor for EffectFlags
source§impl BitXorAssign for EffectFlags
impl BitXorAssign for EffectFlags
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 EffectFlags
impl Clone for EffectFlags
source§fn clone(&self) -> EffectFlags
fn clone(&self) -> EffectFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for EffectFlags
impl Debug for EffectFlags
source§impl Default for EffectFlags
impl Default for EffectFlags
source§fn default() -> EffectFlags
fn default() -> EffectFlags
source§impl<'de> Deserialize<'de> for EffectFlags
impl<'de> Deserialize<'de> for EffectFlags
source§fn 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>,
source§impl Extend<EffectFlags> for EffectFlags
impl Extend<EffectFlags> for EffectFlags
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 EffectFlags
impl Flags for EffectFlags
source§const FLAGS: &'static [Flag<EffectFlags>] = _
const FLAGS: &'static [Flag<EffectFlags>] = _
source§fn from_bits_retain(bits: u32) -> EffectFlags
fn from_bits_retain(bits: u32) -> EffectFlags
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<EffectFlags> for EffectFlags
impl FromIterator<EffectFlags> for EffectFlags
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 EffectFlags
impl Hash for EffectFlags
source§impl IntoIterator for EffectFlags
impl IntoIterator for EffectFlags
source§impl LowerHex for EffectFlags
impl LowerHex for EffectFlags
source§impl Not for EffectFlags
impl Not for EffectFlags
source§impl Octal for EffectFlags
impl Octal for EffectFlags
source§impl Ord for EffectFlags
impl Ord for EffectFlags
source§fn cmp(&self, other: &EffectFlags) -> Ordering
fn cmp(&self, other: &EffectFlags) -> 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 EffectFlags
impl PartialEq for EffectFlags
source§fn eq(&self, other: &EffectFlags) -> bool
fn eq(&self, other: &EffectFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for EffectFlags
impl PartialOrd for EffectFlags
source§fn partial_cmp(&self, other: &EffectFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &EffectFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PublicFlags for EffectFlags
impl PublicFlags for EffectFlags
source§impl Serialize for EffectFlags
impl Serialize for EffectFlags
source§impl Sub for EffectFlags
impl Sub for EffectFlags
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.
§type Output = EffectFlags
type Output = EffectFlags
-
operator.source§impl SubAssign for EffectFlags
impl SubAssign for EffectFlags
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.