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