Struct rustc_middle::ty::TypeFlags

pub struct TypeFlags {
    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: TypeFlags

Does this have Param?

pub const HAS_RE_PARAM: TypeFlags

Does this have ReEarlyBound?

pub const HAS_CT_PARAM: TypeFlags

Does this have ConstKind::Param?

pub const NEEDS_SUBST: TypeFlags

pub const HAS_TY_INFER: TypeFlags

Does this have Infer?

pub const HAS_RE_INFER: TypeFlags

Does this have ReVar?

pub const HAS_CT_INFER: TypeFlags

Does this have ConstKind::Infer?

pub const NEEDS_INFER: TypeFlags

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

pub const HAS_TY_PLACEHOLDER: TypeFlags

Does this have Placeholder?

pub const HAS_RE_PLACEHOLDER: TypeFlags

Does this have RePlaceholder?

pub const HAS_CT_PLACEHOLDER: TypeFlags

Does this have ConstKind::Placeholder?

pub const HAS_FREE_LOCAL_REGIONS: TypeFlags

true if there are "names" of regions and so forth that are local to a particular fn/inferctxt

pub const HAS_FREE_LOCAL_NAMES: TypeFlags

true if there are "names" of types and regions and so forth that are local to a particular fn

pub const HAS_TY_PROJECTION: TypeFlags

Does this have Projection?

pub const HAS_TY_OPAQUE: TypeFlags

Does this have Opaque?

pub const HAS_CT_PROJECTION: TypeFlags

Does this have ConstKind::Unevaluated?

pub const HAS_PROJECTION: TypeFlags

Could this type be normalized further?

pub const HAS_ERROR: TypeFlags

Is an error type/const reachable?

pub const HAS_FREE_REGIONS: TypeFlags

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

pub const HAS_RE_LATE_BOUND: TypeFlags

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

pub const HAS_RE_ERASED: TypeFlags

Does this have any ReErased regions?

pub const STILL_FURTHER_SPECIALIZABLE: TypeFlags

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 MAY_POLYMORPHIZE: TypeFlags

Does this value contain closures, generators or functions such that it may require polymorphization?

pub const fn empty() -> TypeFlags

Returns an empty set of flags

pub const fn all() -> TypeFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<TypeFlags>

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) -> TypeFlags

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> TypeFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: TypeFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

type Output = TypeFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<TypeFlags> for TypeFlags

fn bitand_assign(&mut self, other: TypeFlags)

Disables all flags disabled in the set.

impl BitOr<TypeFlags> for TypeFlags

type Output = TypeFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<TypeFlags> for TypeFlags

fn bitor_assign(&mut self, other: TypeFlags)

Adds the set of flags.

impl BitXor<TypeFlags> for TypeFlags

type Output = TypeFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<TypeFlags> for TypeFlags

fn bitxor_assign(&mut self, other: TypeFlags)

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 Copy for TypeFlags

impl Debug for TypeFlags

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

Formats the value using the given formatter.

impl Eq for TypeFlags

impl Extend<TypeFlags> for TypeFlags

fn extend<T: IntoIterator<Item = TypeFlags>>(&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 = TypeFlags>>(iterator: T) -> TypeFlags

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, 

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

type Output = TypeFlags

The resulting type after applying the ! operator.

fn not(self) -> TypeFlags

Returns the complement of this set of flags.

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

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: &TypeFlags) -> bool

This method tests for !=.

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: &TypeFlags) -> bool

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

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

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

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

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

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

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

impl StructuralEq for TypeFlags

impl StructuralPartialEq for TypeFlags

impl Sub<TypeFlags> for TypeFlags

type Output = TypeFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<TypeFlags> for TypeFlags

fn sub_assign(&mut self, other: TypeFlags)

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.