Struct rustc_type_ir::flags::TypeFlags

pub struct TypeFlags(InternalBitFlags);

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.

Tuple Fields

0: InternalBitFlags

Implementations

impl TypeFlags

pub const HAS_TY_PARAM: Self = _

Does this have Param?

pub const HAS_RE_PARAM: Self = _

Does this have ReEarlyParam?

pub const HAS_CT_PARAM: Self = _

Does this have ConstKind::Param?

pub const HAS_PARAM: 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 HAS_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_PLACEHOLDER: Self = _

Does this have placeholders?

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_WEAK: Self = _

Does this have Weak?

pub const HAS_TY_OPAQUE: Self = _

Does this have Opaque?

pub const HAS_TY_INHERENT: Self = _

Does this have Inherent?

pub const HAS_CT_PROJECTION: Self = _

Does this have ConstKind::Unevaluated?

pub const HAS_ALIAS: Self = _

Does this have Alias or ConstKind::Unevaluated?

Rephrased, could this term be normalized further?

pub const HAS_ERROR: Self = _

Is an error type/lifetime/const reachable?

pub const HAS_FREE_REGIONS: Self = _

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

pub const HAS_RE_BOUND: Self = _

Does this have any ReBound regions?

pub const HAS_TY_BOUND: Self = _

Does this have any Bound types?

pub const HAS_CT_BOUND: Self = _

Does this have any ConstKind::Bound consts?

pub const HAS_BOUND_VARS: 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_COROUTINE: Self = _

Does this have Coroutine or CoroutineWitness?

pub const HAS_BINDER_VARS: Self = _

Does this have any binders with bound vars (e.g. that need to be anonymized)?

impl TypeFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl TypeFlags

pub const fn iter(&self) -> Iter<TypeFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<TypeFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for TypeFlags

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

Formats the value using the given formatter.

impl BitAnd for TypeFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = TypeFlags

The resulting type after applying the & operator.

impl BitAndAssign for TypeFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for TypeFlags

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

The bitwise or (|) of the bits in two flags values.

type Output = TypeFlags

The resulting type after applying the | operator.

impl BitOrAssign for TypeFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for TypeFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = TypeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for TypeFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

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)

The bitwise or (|) of the bits in each flags value.

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

const FLAGS: &'static [Flag<TypeFlags>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> TypeFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<TypeFlags> for TypeFlags

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

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for TypeFlags

type Item = TypeFlags

The type of the elements being iterated over.

type IntoIter = Iter<TypeFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

The bitwise negation (!) of the bits in a flags value, truncating the result.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PublicFlags for TypeFlags

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for TypeFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = TypeFlags

The resulting type after applying the - operator.

impl SubAssign for TypeFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for TypeFlags

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

Formats the value using the given formatter.

impl Copy for TypeFlags

impl Eq 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