Struct rustc_type_ir::TypeFlags

pub struct TypeFlags {
    pub(crate) bits: u32,
}

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

impl TypeFlags

pub const HAS_TY_PARAM: Self = _

Does this have Param?

pub const HAS_RE_PARAM: Self = _

Does this have ReEarlyBound?

pub const HAS_CT_PARAM: Self = _

Does this have ConstKind::Param?

pub const NEEDS_SUBST: Self = _

pub const HAS_TY_INFER: Self = _

Does this have Infer?

pub const HAS_RE_INFER: Self = _

Does this have ReVar?

pub const HAS_CT_INFER: Self = _

Does this have ConstKind::Infer?

pub const NEEDS_INFER: Self = _

Does this have inference variables? Used to determine whether inference is required.

pub const HAS_TY_PLACEHOLDER: Self = _

Does this have Placeholder?

pub const HAS_RE_PLACEHOLDER: Self = _

Does this have RePlaceholder?

pub const HAS_CT_PLACEHOLDER: Self = _

Does this have ConstKind::Placeholder?

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

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

pub const HAS_TY_PROJECTION: Self = _

Does this have Projection?

pub const HAS_TY_OPAQUE: Self = _

Does this have Opaque?

pub const HAS_CT_PROJECTION: Self = _

Does this have ConstKind::Unevaluated?

pub const HAS_PROJECTION: Self = _

Could this type be normalized further?

pub const HAS_ERROR: Self = _

Is an error type/const reachable?

pub const HAS_FREE_REGIONS: Self = _

Does this have any region that “appears free” in the type? Basically anything but ReLateBound and ReErased.

pub const HAS_RE_LATE_BOUND: Self = _

Does this have any ReLateBound regions?

pub const HAS_TY_LATE_BOUND: Self = _

Does this have any Bound types?

pub const HAS_CT_LATE_BOUND: Self = _

Does this have any ConstKind::Bound consts?

pub const HAS_LATE_BOUND: Self = _

Does this have any bound variables? Used to check if a global bound is safe to evaluate.

pub const HAS_RE_ERASED: Self = _

Does this have any ReErased regions?

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?

pub const HAS_TY_FRESH: Self = _

Does this value have InferTy::FreshTy/FreshIntTy/FreshFloatTy?

pub const HAS_CT_FRESH: Self = _

Does this value have InferConst::Fresh?

pub const HAS_TY_GENERATOR: Self = _

Does this have Generator or GeneratorWitness?

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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

impl Binary for TypeFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<TypeFlags> for TypeFlags

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = TypeFlags

The resulting type after applying the & operator.

impl BitAndAssign<TypeFlags> for TypeFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<TypeFlags> for TypeFlags

fn bitor(self, other: TypeFlags) -> Self

Returns the union of the two sets of flags.

type Output = TypeFlags

The resulting type after applying the | operator.

impl BitOrAssign<TypeFlags> for TypeFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<TypeFlags> for TypeFlags

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = TypeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<TypeFlags> for TypeFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for TypeFlags

fn clone(&self) -> TypeFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TypeFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Extend<TypeFlags> for TypeFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<TypeFlags> for TypeFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for TypeFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for TypeFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for TypeFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = TypeFlags

The resulting type after applying the ! operator.

impl Octal for TypeFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for TypeFlags

fn cmp(&self, other: &TypeFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TypeFlags> for TypeFlags

fn eq(&self, other: &TypeFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<TypeFlags> for TypeFlags

fn partial_cmp(&self, other: &TypeFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<TypeFlags> for TypeFlags

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = TypeFlags

The resulting type after applying the - operator.

impl SubAssign<TypeFlags> for TypeFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for TypeFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl __BitFlags for TypeFlags

fn HAS_TY_PARAM(&self) -> bool

fn HAS_RE_PARAM(&self) -> bool

fn HAS_CT_PARAM(&self) -> bool

fn NEEDS_SUBST(&self) -> bool

fn HAS_TY_INFER(&self) -> bool

fn HAS_RE_INFER(&self) -> bool

fn HAS_CT_INFER(&self) -> bool

fn NEEDS_INFER(&self) -> bool

fn HAS_TY_PLACEHOLDER(&self) -> bool

fn HAS_RE_PLACEHOLDER(&self) -> bool

fn HAS_CT_PLACEHOLDER(&self) -> bool

fn HAS_FREE_LOCAL_REGIONS(&self) -> bool

fn HAS_FREE_LOCAL_NAMES(&self) -> bool

fn HAS_TY_PROJECTION(&self) -> bool

fn HAS_TY_OPAQUE(&self) -> bool

fn HAS_CT_PROJECTION(&self) -> bool

fn HAS_PROJECTION(&self) -> bool

fn HAS_ERROR(&self) -> bool

fn HAS_FREE_REGIONS(&self) -> bool

fn HAS_RE_LATE_BOUND(&self) -> bool

fn HAS_TY_LATE_BOUND(&self) -> bool

fn HAS_CT_LATE_BOUND(&self) -> bool

fn HAS_LATE_BOUND(&self) -> bool

fn HAS_RE_ERASED(&self) -> bool

fn STILL_FURTHER_SPECIALIZABLE(&self) -> bool

fn HAS_TY_FRESH(&self) -> bool

fn HAS_CT_FRESH(&self) -> bool

fn HAS_TY_GENERATOR(&self) -> bool

impl __BitFlags for TypeFlags

const HAS_TY_PARAM: u32 = 1u32

const HAS_RE_PARAM: u32 = 2u32

const HAS_CT_PARAM: u32 = 4u32

const NEEDS_SUBST: u32 = 7u32

const HAS_TY_INFER: u32 = 8u32

const HAS_RE_INFER: u32 = 16u32

const HAS_CT_INFER: u32 = 32u32

const NEEDS_INFER: u32 = 56u32

const HAS_TY_PLACEHOLDER: u32 = 64u32

const HAS_RE_PLACEHOLDER: u32 = 128u32

const HAS_CT_PLACEHOLDER: u32 = 256u32

const HAS_FREE_LOCAL_REGIONS: u32 = 512u32

const HAS_FREE_LOCAL_NAMES: u32 = 3_408_749u32

const HAS_TY_PROJECTION: u32 = 1_024u32

const HAS_TY_OPAQUE: u32 = 2_048u32

const HAS_CT_PROJECTION: u32 = 4_096u32

const HAS_PROJECTION: u32 = 7_168u32

const HAS_ERROR: u32 = 8_192u32

const HAS_FREE_REGIONS: u32 = 16_384u32

const HAS_RE_LATE_BOUND: u32 = 32_768u32

const HAS_TY_LATE_BOUND: u32 = 65_536u32

const HAS_CT_LATE_BOUND: u32 = 131_072u32

const HAS_LATE_BOUND: u32 = 229_376u32

const HAS_RE_ERASED: u32 = 262_144u32

const STILL_FURTHER_SPECIALIZABLE: u32 = 524_288u32

const HAS_TY_FRESH: u32 = 1_048_576u32

const HAS_CT_FRESH: u32 = 2_097_152u32

const HAS_TY_GENERATOR: u32 = 4_194_304u32

impl Copy for TypeFlags

impl Eq for TypeFlags

impl StructuralEq for TypeFlags

impl StructuralPartialEq for TypeFlags

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