Enum rustc_type_ir::sty::TyKind

pub enum TyKind<I: Interner> {
    Bool,
    Char,
    Int(IntTy),
    Uint(UintTy),
    Float(FloatTy),
    Adt(I::AdtDef, I::SubstsRef),
    Foreign(I::DefId),
    Str,
    Array(I::Ty, I::Const),
    Slice(I::Ty),
    RawPtr(I::TypeAndMut),
    Ref(I::Region, I::Ty, I::Mutability),
    FnDef(I::DefId, I::SubstsRef),
    FnPtr(I::PolyFnSig),
    Dynamic(I::ListBinderExistentialPredicate, I::Region, DynKind),
    Closure(I::DefId, I::SubstsRef),
    Generator(I::DefId, I::SubstsRef, I::Movability),
    GeneratorWitness(I::BinderListTy),
    Never,
    Tuple(I::ListTy),
    Projection(I::ProjectionTy),
    Opaque(I::DefId, I::SubstsRef),
    Param(I::ParamTy),
    Bound(DebruijnIndex, I::BoundTy),
    Placeholder(I::PlaceholderType),
    Infer(I::InferTy),
    Error(I::DelaySpanBugEmitted),
}

Defines the kinds of types used by the type system.

Types written by the user start out as hir::TyKind and get converted to this representation using AstConv::ast_ty_to_ty.

Variants

Bool

The primitive boolean type. Written as bool.

Char

The primitive character type; holds a Unicode scalar value (a non-surrogate code point). Written as char.

Int(IntTy)

A primitive signed integer type. For example, i32.

Uint(UintTy)

A primitive unsigned integer type. For example, u32.

Float(FloatTy)

A primitive floating-point type. For example, f64.

Adt(I::AdtDef, I::SubstsRef)

Algebraic data types (ADT). For example: structures, enumerations and unions.

For example, the type List<i32> would be represented using the AdtDef for struct List<T> and the substs [i32].

Note that generic parameters in fields only get lazily substituted by using something like adt_def.all_fields().map(|field| field.ty(tcx, substs)).

Foreign(I::DefId)

An unsized FFI type that is opaque to Rust. Written as extern type T.

Str

The pointee of a string slice. Written as str.

Array(I::Ty, I::Const)

An array with the given length. Written as [T; N].

Slice(I::Ty)

The pointee of an array slice. Written as [T].

RawPtr(I::TypeAndMut)

A raw pointer. Written as *mut T or *const T

Ref(I::Region, I::Ty, I::Mutability)

A reference; a pointer with an associated lifetime. Written as &'a mut T or &'a T.

FnDef(I::DefId, I::SubstsRef)

The anonymous type of a function declaration/definition. Each function has a unique type.

For the function fn foo() -> i32 { 3 } this type would be shown to the user as fn() -> i32 {foo}.

For example the type of bar here:

fn foo() -> i32 { 1 }
let bar = foo; // bar: fn() -> i32 {foo}

FnPtr(I::PolyFnSig)

A pointer to a function. Written as fn() -> i32.

Note that both functions and closures start out as either FnDef or Closure which can be then be coerced to this variant.

For example the type of bar here:

fn foo() -> i32 { 1 }
let bar: fn() -> i32 = foo;

Dynamic(I::ListBinderExistentialPredicate, I::Region, DynKind)

A trait object. Written as dyn for<'b> Trait<'b, Assoc = u32> + Send + 'a.

Closure(I::DefId, I::SubstsRef)

The anonymous type of a closure. Used to represent the type of |a| a.

Closure substs contain both the - potentially substituted - generic parameters of its parent and some synthetic parameters. See the documentation for ClosureSubsts for more details.

Generator(I::DefId, I::SubstsRef, I::Movability)

The anonymous type of a generator. Used to represent the type of |a| yield a.

For more info about generator substs, visit the documentation for GeneratorSubsts.

GeneratorWitness(I::BinderListTy)

A type representing the types stored inside a generator. This should only appear as part of the GeneratorSubsts.

Note that the captured variables for generators are stored separately using a tuple in the same way as for closures.

Unlike upvars, the witness can reference lifetimes from inside of the generator itself. To deal with them in the type of the generator, we convert them to higher ranked lifetimes bound by the witness itself.

Looking at the following example, the witness for this generator may end up as something like for<'a> [Vec<i32>, &'a Vec<i32>]:

#![feature(generators)]
|a| {
    let x = &vec![3];
    yield a;
    yield x[0];
}

Never

The never type !.

Tuple(I::ListTy)

A tuple type. For example, (i32, bool).

Projection(I::ProjectionTy)

The projection of an associated type. For example, <T as Trait<..>>::N.

Opaque(I::DefId, I::SubstsRef)

Opaque (impl Trait) type found in a return type.

The DefId comes either from

• the impl Trait ast::Ty node,
• or the type Foo = impl Trait declaration

For RPIT the substitutions are for the generics of the function, while for TAIT it is used for the generic parameters of the alias.

During codegen, tcx.type_of(def_id) can be used to get the underlying type.

Param(I::ParamTy)

A type parameter; for example, T in fn f<T>(x: T) {}.

Bound(DebruijnIndex, I::BoundTy)

Bound type variable, used to represent the 'a in for<'a> fn(&'a ()).

For canonical queries, we replace inference variables with bound variables, so e.g. when checking whether &'_ (): Trait<_> holds, we canonicalize that to for<'a, T> &'a (): Trait<T> and then convert the introduced bound variables back to inference variables in a new inference context when inside of the query.

See the rustc-dev-guide for more details about higher-ranked trait bounds and canonical queries.

Placeholder(I::PlaceholderType)

A placeholder type, used during higher ranked subtyping to instantiate bound variables.

Infer(I::InferTy)

A type variable used during type checking.

Similar to placeholders, inference variables also live in a universe to correctly deal with higher ranked types. Though unlike placeholders, that universe is stored in the InferCtxt instead of directly inside of the type.

Error(I::DelaySpanBugEmitted)

A placeholder for a type which could not be computed; this is propagated to avoid useless error messages.

Implementations

impl<I: Interner> TyKind<I>

pub fn is_primitive(&self) -> bool

Trait Implementations

impl<I: Interner> Clone for TyKind<I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Interner> Debug for TyKind<I>

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

Formats the value using the given formatter.

impl<I: Interner, D: TyDecoder<I = I>> Decodable<D> for TyKind<I>where
    I::DelaySpanBugEmitted: Decodable<D>,
    I::AdtDef: Decodable<D>,
    I::SubstsRef: Decodable<D>,
    I::DefId: Decodable<D>,
    I::Ty: Decodable<D>,
    I::Const: Decodable<D>,
    I::Region: Decodable<D>,
    I::TypeAndMut: Decodable<D>,
    I::Mutability: Decodable<D>,
    I::Movability: Decodable<D>,
    I::PolyFnSig: Decodable<D>,
    I::ListBinderExistentialPredicate: Decodable<D>,
    I::BinderListTy: Decodable<D>,
    I::ListTy: Decodable<D>,
    I::ProjectionTy: Decodable<D>,
    I::ParamTy: Decodable<D>,
    I::BoundTy: Decodable<D>,
    I::PlaceholderType: Decodable<D>,
    I::InferTy: Decodable<D>,
    I::DelaySpanBugEmitted: Decodable<D>,
    I::PredicateKind: Decodable<D>,
    I::AllocId: Decodable<D>,

fn decode(d: &mut D) -> Self

impl<I: Interner, E: TyEncoder> Encodable<E> for TyKind<I>where
    I::DelaySpanBugEmitted: Encodable<E>,
    I::AdtDef: Encodable<E>,
    I::SubstsRef: Encodable<E>,
    I::DefId: Encodable<E>,
    I::Ty: Encodable<E>,
    I::Const: Encodable<E>,
    I::Region: Encodable<E>,
    I::TypeAndMut: Encodable<E>,
    I::Mutability: Encodable<E>,
    I::Movability: Encodable<E>,
    I::PolyFnSig: Encodable<E>,
    I::ListBinderExistentialPredicate: Encodable<E>,
    I::BinderListTy: Encodable<E>,
    I::ListTy: Encodable<E>,
    I::ProjectionTy: Encodable<E>,
    I::ParamTy: Encodable<E>,
    I::BoundTy: Encodable<E>,
    I::PlaceholderType: Encodable<E>,
    I::InferTy: Encodable<E>,
    I::DelaySpanBugEmitted: Encodable<E>,
    I::PredicateKind: Encodable<E>,
    I::AllocId: Encodable<E>,

fn encode(&self, e: &mut E)

impl<I: Interner> Hash for TyKind<I>

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<CTX: HashStableContext, I: Interner> HashStable<CTX> for TyKind<I>where
    I::AdtDef: HashStable<CTX>,
    I::DefId: HashStable<CTX>,
    I::SubstsRef: HashStable<CTX>,
    I::Ty: HashStable<CTX>,
    I::Const: HashStable<CTX>,
    I::TypeAndMut: HashStable<CTX>,
    I::PolyFnSig: HashStable<CTX>,
    I::ListBinderExistentialPredicate: HashStable<CTX>,
    I::Region: HashStable<CTX>,
    I::Movability: HashStable<CTX>,
    I::Mutability: HashStable<CTX>,
    I::BinderListTy: HashStable<CTX>,
    I::ListTy: HashStable<CTX>,
    I::ProjectionTy: HashStable<CTX>,
    I::BoundTy: HashStable<CTX>,
    I::ParamTy: HashStable<CTX>,
    I::PlaceholderType: HashStable<CTX>,
    I::InferTy: HashStable<CTX>,
    I::DelaySpanBugEmitted: HashStable<CTX>,

fn hash_stable(&self, __hcx: &mut CTX, __hasher: &mut StableHasher)

impl<I: Interner> Ord for TyKind<I>

fn cmp(&self, other: &TyKind<I>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<I: Interner> PartialEq<TyKind<I>> for TyKind<I>

fn eq(&self, other: &TyKind<I>) -> 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<I: Interner> PartialOrd<TyKind<I>> for TyKind<I>

fn partial_cmp(&self, other: &TyKind<I>) -> 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<I: Interner> Eq for TyKind<I>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.