Struct rustc_type_ir::TypeFlags
source · pub struct TypeFlags {
pub(crate) bits: u32,
}
Expand description
Flags that we track on types. These flags are propagated upwards through the type during type construction, so that we can quickly check whether the type has various kinds of types in it without recursing over the type itself.
Fields§
§bits: u32
Implementations§
source§impl TypeFlags
impl TypeFlags
sourcepub const HAS_TY_PARAM: Self = _
pub const HAS_TY_PARAM: Self = _
Does this have Param
?
sourcepub const HAS_RE_PARAM: Self = _
pub const HAS_RE_PARAM: Self = _
Does this have ReEarlyBound
?
sourcepub const HAS_CT_PARAM: Self = _
pub const HAS_CT_PARAM: Self = _
Does this have ConstKind::Param
?
pub const HAS_PARAM: Self = _
sourcepub const HAS_TY_INFER: Self = _
pub const HAS_TY_INFER: Self = _
Does this have Infer
?
sourcepub const HAS_RE_INFER: Self = _
pub const HAS_RE_INFER: Self = _
Does this have ReVar
?
sourcepub const HAS_CT_INFER: Self = _
pub const HAS_CT_INFER: Self = _
Does this have ConstKind::Infer
?
sourcepub const HAS_INFER: Self = _
pub const HAS_INFER: Self = _
Does this have inference variables? Used to determine whether inference is required.
sourcepub const HAS_TY_PLACEHOLDER: Self = _
pub const HAS_TY_PLACEHOLDER: Self = _
Does this have Placeholder
?
sourcepub const HAS_RE_PLACEHOLDER: Self = _
pub const HAS_RE_PLACEHOLDER: Self = _
Does this have RePlaceholder
?
sourcepub const HAS_CT_PLACEHOLDER: Self = _
pub const HAS_CT_PLACEHOLDER: Self = _
Does this have ConstKind::Placeholder
?
sourcepub const HAS_PLACEHOLDER: Self = _
pub const HAS_PLACEHOLDER: Self = _
Does this have placeholders?
sourcepub const HAS_FREE_LOCAL_REGIONS: Self = _
pub const HAS_FREE_LOCAL_REGIONS: Self = _
true
if there are “names” of regions and so forth
that are local to a particular fn/inferctxt
sourcepub const HAS_FREE_LOCAL_NAMES: Self = _
pub const HAS_FREE_LOCAL_NAMES: Self = _
true
if there are “names” of types and regions and so forth
that are local to a particular fn
sourcepub const HAS_TY_PROJECTION: Self = _
pub const HAS_TY_PROJECTION: Self = _
Does this have Projection
?
sourcepub const HAS_TY_INHERENT: Self = _
pub const HAS_TY_INHERENT: Self = _
Does this have Inherent
?
sourcepub const HAS_TY_OPAQUE: Self = _
pub const HAS_TY_OPAQUE: Self = _
Does this have Opaque
?
sourcepub const HAS_CT_PROJECTION: Self = _
pub const HAS_CT_PROJECTION: Self = _
Does this have ConstKind::Unevaluated
?
sourcepub const HAS_PROJECTION: Self = _
pub const HAS_PROJECTION: Self = _
Could this type be normalized further?
sourcepub const HAS_FREE_REGIONS: Self = _
pub const HAS_FREE_REGIONS: Self = _
Does this have any region that “appears free” in the type?
Basically anything but ReLateBound
and ReErased
.
sourcepub const HAS_RE_LATE_BOUND: Self = _
pub const HAS_RE_LATE_BOUND: Self = _
Does this have any ReLateBound
regions?
sourcepub const HAS_TY_LATE_BOUND: Self = _
pub const HAS_TY_LATE_BOUND: Self = _
Does this have any Bound
types?
sourcepub const HAS_CT_LATE_BOUND: Self = _
pub const HAS_CT_LATE_BOUND: Self = _
Does this have any ConstKind::Bound
consts?
sourcepub const HAS_LATE_BOUND: Self = _
pub const HAS_LATE_BOUND: Self = _
Does this have any bound variables? Used to check if a global bound is safe to evaluate.
sourcepub const HAS_RE_ERASED: Self = _
pub const HAS_RE_ERASED: Self = _
Does this have any ReErased
regions?
sourcepub const STILL_FURTHER_SPECIALIZABLE: Self = _
pub const STILL_FURTHER_SPECIALIZABLE: Self = _
Does this value have parameters/placeholders/inference variables which could be
replaced later, in a way that would change the results of impl
specialization?
sourcepub const HAS_TY_FRESH: Self = _
pub const HAS_TY_FRESH: Self = _
Does this value have InferTy::FreshTy/FreshIntTy/FreshFloatTy
?
sourcepub const HAS_CT_FRESH: Self = _
pub const HAS_CT_FRESH: Self = _
Does this value have InferConst::Fresh
?
sourcepub const HAS_TY_GENERATOR: Self = _
pub const HAS_TY_GENERATOR: Self = _
Does this have Generator
or GeneratorWitness
?
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§
source§impl BitAndAssign<TypeFlags> for TypeFlags
impl BitAndAssign<TypeFlags> for TypeFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign<TypeFlags> for TypeFlags
impl BitOrAssign<TypeFlags> for TypeFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<TypeFlags> for TypeFlags
impl BitXorAssign<TypeFlags> for TypeFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<TypeFlags> for TypeFlags
impl Extend<TypeFlags> for TypeFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<TypeFlags> for TypeFlags
impl FromIterator<TypeFlags> for TypeFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for TypeFlags
impl Ord for TypeFlags
source§impl PartialEq<TypeFlags> for TypeFlags
impl PartialEq<TypeFlags> for TypeFlags
source§impl PartialOrd<TypeFlags> for TypeFlags
impl PartialOrd<TypeFlags> for TypeFlags
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 SubAssign<TypeFlags> for TypeFlags
impl SubAssign<TypeFlags> for TypeFlags
source§fn 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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 4 bytes