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