Struct esl::SpellFlags
source · pub struct SpellFlags { /* private fields */ }
Implementations
sourceimpl SpellFlags
impl SpellFlags
pub const AUTO_CALCULATE_COST: Self = _
pub const PC_START: Self = _
pub const ALWAYS_SUCCEEDS: 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 SpellFlags
impl Binary for SpellFlags
sourceimpl BitAnd<SpellFlags> for SpellFlags
impl BitAnd<SpellFlags> for SpellFlags
type Output = SpellFlags
type Output = SpellFlags
&
operator.sourceimpl BitAndAssign<SpellFlags> for SpellFlags
impl BitAndAssign<SpellFlags> for SpellFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<SpellFlags> for SpellFlags
impl BitOr<SpellFlags> for SpellFlags
sourcefn bitor(self, other: SpellFlags) -> Self
fn bitor(self, other: SpellFlags) -> Self
Returns the union of the two sets of flags.
type Output = SpellFlags
type Output = SpellFlags
|
operator.sourceimpl BitOrAssign<SpellFlags> for SpellFlags
impl BitOrAssign<SpellFlags> for SpellFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<SpellFlags> for SpellFlags
impl BitXor<SpellFlags> for SpellFlags
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 = SpellFlags
type Output = SpellFlags
^
operator.sourceimpl BitXorAssign<SpellFlags> for SpellFlags
impl BitXorAssign<SpellFlags> for SpellFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for SpellFlags
impl Clone for SpellFlags
sourcefn clone(&self) -> SpellFlags
fn clone(&self) -> SpellFlags
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for SpellFlags
impl Debug for SpellFlags
sourceimpl Default for SpellFlags
impl Default for SpellFlags
sourcefn default() -> SpellFlags
fn default() -> SpellFlags
sourceimpl<'de> Deserialize<'de> for SpellFlags
impl<'de> Deserialize<'de> for SpellFlags
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 SpellFlags
impl Display for SpellFlags
sourceimpl Extend<SpellFlags> for SpellFlags
impl Extend<SpellFlags> for SpellFlags
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 FromIterator<SpellFlags> for SpellFlags
impl FromIterator<SpellFlags> for SpellFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl FromStr for SpellFlags
impl FromStr for SpellFlags
sourceimpl Hash for SpellFlags
impl Hash for SpellFlags
sourceimpl LowerHex for SpellFlags
impl LowerHex for SpellFlags
sourceimpl Not for SpellFlags
impl Not for SpellFlags
type Output = SpellFlags
type Output = SpellFlags
!
operator.sourceimpl Octal for SpellFlags
impl Octal for SpellFlags
sourceimpl Ord for SpellFlags
impl Ord for SpellFlags
sourcefn cmp(&self, other: &SpellFlags) -> Ordering
fn cmp(&self, other: &SpellFlags) -> 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<SpellFlags> for SpellFlags
impl PartialEq<SpellFlags> for SpellFlags
sourcefn eq(&self, other: &SpellFlags) -> bool
fn eq(&self, other: &SpellFlags) -> bool
sourceimpl PartialOrd<SpellFlags> for SpellFlags
impl PartialOrd<SpellFlags> for SpellFlags
sourcefn partial_cmp(&self, other: &SpellFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &SpellFlags) -> 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 SpellFlags
impl Serialize for SpellFlags
sourceimpl Sub<SpellFlags> for SpellFlags
impl Sub<SpellFlags> for SpellFlags
type Output = SpellFlags
type Output = SpellFlags
-
operator.sourceimpl SubAssign<SpellFlags> for SpellFlags
impl SubAssign<SpellFlags> for SpellFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.