pub struct TypeFlags { /* private fields */ }
Expand description
Contains flags indicating various properties of a Ty
Implementations
sourceimpl TypeFlags
impl TypeFlags
sourcepub const HAS_TY_INFER: Self = _
pub const HAS_TY_INFER: Self = _
Does the type contain an InferenceVar
sourcepub const HAS_RE_INFER: Self = _
pub const HAS_RE_INFER: Self = _
Does the type contain a lifetime with an InferenceVar
sourcepub const HAS_CT_INFER: Self = _
pub const HAS_CT_INFER: Self = _
Does the type contain a ConstValue with an InferenceVar
sourcepub const HAS_TY_PLACEHOLDER: Self = _
pub const HAS_TY_PLACEHOLDER: Self = _
Does the type contain a Placeholder TyKind
sourcepub const HAS_RE_PLACEHOLDER: Self = _
pub const HAS_RE_PLACEHOLDER: Self = _
Does the type contain a lifetime with a Placeholder
sourcepub const HAS_CT_PLACEHOLDER: Self = _
pub const HAS_CT_PLACEHOLDER: Self = _
Does the type contain a ConstValue Placeholder
sourcepub const HAS_FREE_LOCAL_REGIONS: Self = _
pub const HAS_FREE_LOCAL_REGIONS: Self = _
True when the type has free lifetimes related to a local context
sourcepub const HAS_TY_PROJECTION: Self = _
pub const HAS_TY_PROJECTION: Self = _
Does the type contain a projection of an associated type
sourcepub const HAS_TY_OPAQUE: Self = _
pub const HAS_TY_OPAQUE: Self = _
Does the type contain an opaque type
sourcepub const HAS_CT_PROJECTION: Self = _
pub const HAS_CT_PROJECTION: Self = _
Does the type contain an unevaluated const projection
sourcepub const HAS_FREE_REGIONS: Self = _
pub const HAS_FREE_REGIONS: Self = _
Does the type contain any free lifetimes
sourcepub const HAS_RE_LATE_BOUND: Self = _
pub const HAS_RE_LATE_BOUND: Self = _
True when the type contains lifetimes that will be substituted when function is called
sourcepub const HAS_RE_ERASED: Self = _
pub const HAS_RE_ERASED: Self = _
True when the type contains an erased lifetime
sourcepub const STILL_FURTHER_SPECIALIZABLE: Self = _
pub const STILL_FURTHER_SPECIALIZABLE: Self = _
Does the type contain placeholders or inference variables that could be replaced later
sourcepub const HAS_FREE_LOCAL_NAMES: Self = _
pub const HAS_FREE_LOCAL_NAMES: Self = _
True when the type contains free names local to a particular context
sourcepub const HAS_PROJECTION: Self = _
pub const HAS_PROJECTION: Self = _
Does the type contain any form of projection
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 BitAndAssign<TypeFlags> for TypeFlags
impl BitAndAssign<TypeFlags> for TypeFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOrAssign<TypeFlags> for TypeFlags
impl BitOrAssign<TypeFlags> for TypeFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXorAssign<TypeFlags> for TypeFlags
impl BitXorAssign<TypeFlags> for TypeFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Extend<TypeFlags> for TypeFlags
impl Extend<TypeFlags> for TypeFlags
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<TypeFlags> for TypeFlags
impl FromIterator<TypeFlags> for TypeFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Ord for TypeFlags
impl Ord for TypeFlags
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialOrd<TypeFlags> for TypeFlags
impl PartialOrd<TypeFlags> for TypeFlags
sourcefn partial_cmp(&self, other: &TypeFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &TypeFlags) -> 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 SubAssign<TypeFlags> for TypeFlags
impl SubAssign<TypeFlags> for TypeFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
impl Copy for TypeFlags
impl Eq for TypeFlags
impl StructuralEq for TypeFlags
impl StructuralPartialEq for TypeFlags
Auto Trait Implementations
impl RefUnwindSafe for TypeFlags
impl Send for TypeFlags
impl Sync for TypeFlags
impl Unpin for TypeFlags
impl UnwindSafe for TypeFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<T> Cast for T
impl<T> Cast for T
sourcefn cast<U>(self, interner: U::Interner) -> Uwhere
Self: CastTo<U>,
U: HasInterner,
fn cast<U>(self, interner: U::Interner) -> Uwhere
Self: CastTo<U>,
U: HasInterner,
U
using CastTo
.