Struct esl::AiTargetFlags
source · pub struct AiTargetFlags { /* private fields */ }
Implementations
sourceimpl AiTargetFlags
impl AiTargetFlags
pub const _1: Self = _
pub const _2: Self = _
pub const _4: Self = _
pub const _8: Self = _
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> 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 AiTargetFlags
impl Binary for AiTargetFlags
sourceimpl BitAnd<AiTargetFlags> for AiTargetFlags
impl BitAnd<AiTargetFlags> for AiTargetFlags
type Output = AiTargetFlags
type Output = AiTargetFlags
&
operator.sourceimpl BitAndAssign<AiTargetFlags> for AiTargetFlags
impl BitAndAssign<AiTargetFlags> for AiTargetFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<AiTargetFlags> for AiTargetFlags
impl BitOr<AiTargetFlags> for AiTargetFlags
sourcefn bitor(self, other: AiTargetFlags) -> Self
fn bitor(self, other: AiTargetFlags) -> Self
Returns the union of the two sets of flags.
type Output = AiTargetFlags
type Output = AiTargetFlags
|
operator.sourceimpl BitOrAssign<AiTargetFlags> for AiTargetFlags
impl BitOrAssign<AiTargetFlags> for AiTargetFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<AiTargetFlags> for AiTargetFlags
impl BitXor<AiTargetFlags> for AiTargetFlags
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 = AiTargetFlags
type Output = AiTargetFlags
^
operator.sourceimpl BitXorAssign<AiTargetFlags> for AiTargetFlags
impl BitXorAssign<AiTargetFlags> for AiTargetFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for AiTargetFlags
impl Clone for AiTargetFlags
sourcefn clone(&self) -> AiTargetFlags
fn clone(&self) -> AiTargetFlags
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for AiTargetFlags
impl Debug for AiTargetFlags
sourceimpl Default for AiTargetFlags
impl Default for AiTargetFlags
sourcefn default() -> AiTargetFlags
fn default() -> AiTargetFlags
sourceimpl<'de> Deserialize<'de> for AiTargetFlags
impl<'de> Deserialize<'de> for AiTargetFlags
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 AiTargetFlags
impl Display for AiTargetFlags
sourceimpl Extend<AiTargetFlags> for AiTargetFlags
impl Extend<AiTargetFlags> for AiTargetFlags
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<AiTargetFlags> for AiTargetFlags
impl FromIterator<AiTargetFlags> for AiTargetFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl FromStr for AiTargetFlags
impl FromStr for AiTargetFlags
sourceimpl Hash for AiTargetFlags
impl Hash for AiTargetFlags
sourceimpl LowerHex for AiTargetFlags
impl LowerHex for AiTargetFlags
sourceimpl Not for AiTargetFlags
impl Not for AiTargetFlags
type Output = AiTargetFlags
type Output = AiTargetFlags
!
operator.sourceimpl Octal for AiTargetFlags
impl Octal for AiTargetFlags
sourceimpl Ord for AiTargetFlags
impl Ord for AiTargetFlags
sourcefn cmp(&self, other: &AiTargetFlags) -> Ordering
fn cmp(&self, other: &AiTargetFlags) -> 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<AiTargetFlags> for AiTargetFlags
impl PartialEq<AiTargetFlags> for AiTargetFlags
sourcefn eq(&self, other: &AiTargetFlags) -> bool
fn eq(&self, other: &AiTargetFlags) -> bool
sourceimpl PartialOrd<AiTargetFlags> for AiTargetFlags
impl PartialOrd<AiTargetFlags> for AiTargetFlags
sourcefn partial_cmp(&self, other: &AiTargetFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &AiTargetFlags) -> 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 AiTargetFlags
impl Serialize for AiTargetFlags
sourceimpl Sub<AiTargetFlags> for AiTargetFlags
impl Sub<AiTargetFlags> for AiTargetFlags
type Output = AiTargetFlags
type Output = AiTargetFlags
-
operator.sourceimpl SubAssign<AiTargetFlags> for AiTargetFlags
impl SubAssign<AiTargetFlags> for AiTargetFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.