Enum rustc_type_ir::TyKind
source · pub enum TyKind<I: Interner> {
Show 28 variants
Bool,
Char,
Int(IntTy),
Uint(UintTy),
Float(FloatTy),
Adt(I::AdtDef, I::GenericArgs),
Foreign(I::DefId),
Str,
Array(I::Ty, I::Const),
Pat(I::Ty, I::Pat),
Slice(I::Ty),
RawPtr(I::Ty, Mutability),
Ref(I::Region, I::Ty, Mutability),
FnDef(I::DefId, I::GenericArgs),
FnPtr(Binder<I, FnSigTys<I>>, FnHeader<I>),
Dynamic(I::BoundExistentialPredicates, I::Region, DynKind),
Closure(I::DefId, I::GenericArgs),
CoroutineClosure(I::DefId, I::GenericArgs),
Coroutine(I::DefId, I::GenericArgs),
CoroutineWitness(I::DefId, I::GenericArgs),
Never,
Tuple(I::Tys),
Alias(AliasTyKind, AliasTy<I>),
Param(I::ParamTy),
Bound(DebruijnIndex, I::BoundTy),
Placeholder(I::PlaceholderTy),
Infer(InferTy),
Error(I::ErrorGuaranteed),
}
Expand description
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 <dyn HirTyLowerer>::lower_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::GenericArgs)
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 args [i32]
.
Note that generic parameters in fields only get lazily instantiated
by using something like adt_def.all_fields().map(|field| field.ty(interner, args))
.
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]
.
Pat(I::Ty, I::Pat)
A pattern newtype. Takes any type and restricts its valid values to its pattern.
This will also change the layout to take advantage of this restriction.
Only Copy
and Clone
will automatically get implemented for pattern types.
Auto-traits treat this as if it were an aggregate with a single nested type.
Only supports integer range patterns for now.
Slice(I::Ty)
The pointee of an array slice. Written as [T]
.
RawPtr(I::Ty, Mutability)
A raw pointer. Written as *mut T
or *const T
Ref(I::Region, I::Ty, Mutability)
A reference; a pointer with an associated lifetime. Written as
&'a mut T
or &'a T
.
FnDef(I::DefId, I::GenericArgs)
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(Binder<I, FnSigTys<I>>, FnHeader<I>)
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;
These two fields are equivalent to a ty::Binder<I, FnSig<I>>
. But by
splitting that into two pieces, we get a more compact data layout that
reduces the size of TyKind
by 8 bytes. It is a very hot type, so it’s
worth the mild inconvenience.
Dynamic(I::BoundExistentialPredicates, I::Region, DynKind)
A trait object. Written as dyn for<'b> Trait<'b, Assoc = u32> + Send + 'a
.
Closure(I::DefId, I::GenericArgs)
The anonymous type of a closure. Used to represent the type of |a| a
.
Closure args contain both the - potentially instantiated - generic parameters
of its parent and some synthetic parameters. See the documentation for
ClosureArgs
for more details.
CoroutineClosure(I::DefId, I::GenericArgs)
The anonymous type of a closure. Used to represent the type of async |a| a
.
Coroutine-closure args contain both the - potentially instantiated - generic
parameters of its parent and some synthetic parameters. See the documentation
for CoroutineClosureArgs
for more details.
Coroutine(I::DefId, I::GenericArgs)
The anonymous type of a coroutine. Used to represent the type of
|a| yield a
.
For more info about coroutine args, visit the documentation for
CoroutineArgs
.
CoroutineWitness(I::DefId, I::GenericArgs)
A type representing the types stored inside a coroutine.
This should only appear as part of the CoroutineArgs
.
Unlike upvars, the witness can reference lifetimes from inside of the coroutine itself. To deal with them in the type of the coroutine, we convert them to higher ranked lifetimes bound by the witness itself.
This contains the DefId
and the GenericArgsRef
of the coroutine.
The actual witness types are computed on MIR by the mir_coroutine_witnesses
query.
Looking at the following example, the witness for this coroutine
may end up as something like for<'a> [Vec<i32>, &'a Vec<i32>]
:
#![feature(coroutines)]
#[coroutine] static |a| {
let x = &vec![3];
yield a;
yield x[0];
}
Never
The never type !
.
Tuple(I::Tys)
A tuple type. For example, (i32, bool)
.
Alias(AliasTyKind, AliasTy<I>)
A projection, opaque type, weak type alias, or inherent associated type. All of these types are represented as pairs of def-id and args, and can be normalized, so they are grouped conceptually.
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.
It is conventional to render anonymous bound types like ^N
or ^D_N
,
where N
is the bound variable’s anonymous index into the binder, and
D
is the debruijn index, or totally omitted if the debruijn index is zero.
See the rustc-dev-guide
for more details about
higher-ranked trait bounds and canonical queries.
Placeholder(I::PlaceholderTy)
A placeholder type, used during higher ranked subtyping to instantiate bound variables.
It is conventional to render anonymous placeholder types like !N
or !U_N
,
where N
is the placeholder variable’s anonymous index (which corresponds
to the bound variable’s index from the binder from which it was instantiated),
and U
is the universe index in which it is instantiated, or totally omitted
if the universe index is zero.
Infer(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::ErrorGuaranteed)
A placeholder for a type which could not be computed; this is propagated to avoid useless error messages.
Trait Implementations§
source§impl<I: Interner, __D: TyDecoder<I = I>> Decodable<__D> for TyKind<I>where
I::AdtDef: Decodable<__D>,
I::GenericArgs: Decodable<__D>,
I::DefId: Decodable<__D>,
I::Ty: Decodable<__D>,
I::Const: Decodable<__D>,
I::Pat: Decodable<__D>,
I::Region: Decodable<__D>,
Binder<I, FnSigTys<I>>: Decodable<__D>,
FnHeader<I>: Decodable<__D>,
I::BoundExistentialPredicates: Decodable<__D>,
I::Tys: Decodable<__D>,
AliasTy<I>: Decodable<__D>,
I::ParamTy: Decodable<__D>,
I::BoundTy: Decodable<__D>,
I::PlaceholderTy: Decodable<__D>,
I::ErrorGuaranteed: Decodable<__D>,
impl<I: Interner, __D: TyDecoder<I = I>> Decodable<__D> for TyKind<I>where
I::AdtDef: Decodable<__D>,
I::GenericArgs: Decodable<__D>,
I::DefId: Decodable<__D>,
I::Ty: Decodable<__D>,
I::Const: Decodable<__D>,
I::Pat: Decodable<__D>,
I::Region: Decodable<__D>,
Binder<I, FnSigTys<I>>: Decodable<__D>,
FnHeader<I>: Decodable<__D>,
I::BoundExistentialPredicates: Decodable<__D>,
I::Tys: Decodable<__D>,
AliasTy<I>: Decodable<__D>,
I::ParamTy: Decodable<__D>,
I::BoundTy: Decodable<__D>,
I::PlaceholderTy: Decodable<__D>,
I::ErrorGuaranteed: Decodable<__D>,
source§impl<I: Interner, __E: TyEncoder<I = I>> Encodable<__E> for TyKind<I>where
I::AdtDef: Encodable<__E>,
I::GenericArgs: Encodable<__E>,
I::DefId: Encodable<__E>,
I::Ty: Encodable<__E>,
I::Const: Encodable<__E>,
I::Pat: Encodable<__E>,
I::Region: Encodable<__E>,
Binder<I, FnSigTys<I>>: Encodable<__E>,
FnHeader<I>: Encodable<__E>,
I::BoundExistentialPredicates: Encodable<__E>,
I::Tys: Encodable<__E>,
AliasTy<I>: Encodable<__E>,
I::ParamTy: Encodable<__E>,
I::BoundTy: Encodable<__E>,
I::PlaceholderTy: Encodable<__E>,
I::ErrorGuaranteed: Encodable<__E>,
impl<I: Interner, __E: TyEncoder<I = I>> Encodable<__E> for TyKind<I>where
I::AdtDef: Encodable<__E>,
I::GenericArgs: Encodable<__E>,
I::DefId: Encodable<__E>,
I::Ty: Encodable<__E>,
I::Const: Encodable<__E>,
I::Pat: Encodable<__E>,
I::Region: Encodable<__E>,
Binder<I, FnSigTys<I>>: Encodable<__E>,
FnHeader<I>: Encodable<__E>,
I::BoundExistentialPredicates: Encodable<__E>,
I::Tys: Encodable<__E>,
AliasTy<I>: Encodable<__E>,
I::ParamTy: Encodable<__E>,
I::BoundTy: Encodable<__E>,
I::PlaceholderTy: Encodable<__E>,
I::ErrorGuaranteed: Encodable<__E>,
source§impl<I: Interner, __CTX> HashStable<__CTX> for TyKind<I>where
I::AdtDef: HashStable<__CTX>,
I::GenericArgs: HashStable<__CTX>,
I::DefId: HashStable<__CTX>,
I::Ty: HashStable<__CTX>,
I::Const: HashStable<__CTX>,
I::Pat: HashStable<__CTX>,
I::Region: HashStable<__CTX>,
Binder<I, FnSigTys<I>>: HashStable<__CTX>,
FnHeader<I>: HashStable<__CTX>,
I::BoundExistentialPredicates: HashStable<__CTX>,
I::Tys: HashStable<__CTX>,
AliasTy<I>: HashStable<__CTX>,
I::ParamTy: HashStable<__CTX>,
I::BoundTy: HashStable<__CTX>,
I::PlaceholderTy: HashStable<__CTX>,
I::ErrorGuaranteed: HashStable<__CTX>,
impl<I: Interner, __CTX> HashStable<__CTX> for TyKind<I>where
I::AdtDef: HashStable<__CTX>,
I::GenericArgs: HashStable<__CTX>,
I::DefId: HashStable<__CTX>,
I::Ty: HashStable<__CTX>,
I::Const: HashStable<__CTX>,
I::Pat: HashStable<__CTX>,
I::Region: HashStable<__CTX>,
Binder<I, FnSigTys<I>>: HashStable<__CTX>,
FnHeader<I>: HashStable<__CTX>,
I::BoundExistentialPredicates: HashStable<__CTX>,
I::Tys: HashStable<__CTX>,
AliasTy<I>: HashStable<__CTX>,
I::ParamTy: HashStable<__CTX>,
I::BoundTy: HashStable<__CTX>,
I::PlaceholderTy: HashStable<__CTX>,
I::ErrorGuaranteed: HashStable<__CTX>,
fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)
impl<I> Copy for TyKind<I>where
I: Interner,
impl<I> Eq for TyKind<I>where
I: Interner,
Auto Trait Implementations§
impl<I> DynSend for TyKind<I>where
<I as Interner>::AdtDef: DynSend,
<I as Interner>::GenericArgs: DynSend,
<I as Interner>::DefId: DynSend,
<I as Interner>::Ty: DynSend,
<I as Interner>::Const: DynSend,
<I as Interner>::Pat: DynSend,
<I as Interner>::Region: DynSend,
<I as Interner>::BoundExistentialPredicates: DynSend,
<I as Interner>::Tys: DynSend,
<I as Interner>::ParamTy: DynSend,
<I as Interner>::BoundTy: DynSend,
<I as Interner>::PlaceholderTy: DynSend,
<I as Interner>::ErrorGuaranteed: DynSend,
<I as Interner>::BoundVarKinds: DynSend,
<I as Interner>::Safety: DynSend,
<I as Interner>::Abi: DynSend,
impl<I> DynSync for TyKind<I>where
<I as Interner>::AdtDef: DynSync,
<I as Interner>::GenericArgs: DynSync,
<I as Interner>::DefId: DynSync,
<I as Interner>::Ty: DynSync,
<I as Interner>::Const: DynSync,
<I as Interner>::Pat: DynSync,
<I as Interner>::Region: DynSync,
<I as Interner>::BoundExistentialPredicates: DynSync,
<I as Interner>::Tys: DynSync,
<I as Interner>::ParamTy: DynSync,
<I as Interner>::BoundTy: DynSync,
<I as Interner>::PlaceholderTy: DynSync,
<I as Interner>::ErrorGuaranteed: DynSync,
<I as Interner>::BoundVarKinds: DynSync,
<I as Interner>::Safety: DynSync,
<I as Interner>::Abi: DynSync,
impl<I> Freeze for TyKind<I>where
<I as Interner>::AdtDef: Freeze,
<I as Interner>::GenericArgs: Freeze,
<I as Interner>::DefId: Freeze,
<I as Interner>::Ty: Freeze,
<I as Interner>::Const: Freeze,
<I as Interner>::Pat: Freeze,
<I as Interner>::Region: Freeze,
<I as Interner>::BoundExistentialPredicates: Freeze,
<I as Interner>::Tys: Freeze,
<I as Interner>::ParamTy: Freeze,
<I as Interner>::BoundTy: Freeze,
<I as Interner>::PlaceholderTy: Freeze,
<I as Interner>::ErrorGuaranteed: Freeze,
<I as Interner>::BoundVarKinds: Freeze,
<I as Interner>::Safety: Freeze,
<I as Interner>::Abi: Freeze,
impl<I> RefUnwindSafe for TyKind<I>where
<I as Interner>::AdtDef: RefUnwindSafe,
<I as Interner>::GenericArgs: RefUnwindSafe,
<I as Interner>::DefId: RefUnwindSafe,
<I as Interner>::Ty: RefUnwindSafe,
<I as Interner>::Const: RefUnwindSafe,
<I as Interner>::Pat: RefUnwindSafe,
<I as Interner>::Region: RefUnwindSafe,
<I as Interner>::BoundExistentialPredicates: RefUnwindSafe,
<I as Interner>::Tys: RefUnwindSafe,
<I as Interner>::ParamTy: RefUnwindSafe,
<I as Interner>::BoundTy: RefUnwindSafe,
<I as Interner>::PlaceholderTy: RefUnwindSafe,
<I as Interner>::ErrorGuaranteed: RefUnwindSafe,
<I as Interner>::BoundVarKinds: RefUnwindSafe,
<I as Interner>::Safety: RefUnwindSafe,
<I as Interner>::Abi: RefUnwindSafe,
impl<I> Send for TyKind<I>where
<I as Interner>::AdtDef: Send,
<I as Interner>::GenericArgs: Send,
<I as Interner>::DefId: Send,
<I as Interner>::Ty: Send,
<I as Interner>::Const: Send,
<I as Interner>::Pat: Send,
<I as Interner>::Region: Send,
<I as Interner>::BoundExistentialPredicates: Send,
<I as Interner>::Tys: Send,
<I as Interner>::ParamTy: Send,
<I as Interner>::BoundTy: Send,
<I as Interner>::PlaceholderTy: Send,
<I as Interner>::ErrorGuaranteed: Send,
<I as Interner>::BoundVarKinds: Send,
<I as Interner>::Safety: Send,
<I as Interner>::Abi: Send,
impl<I> Sync for TyKind<I>where
<I as Interner>::AdtDef: Sync,
<I as Interner>::GenericArgs: Sync,
<I as Interner>::DefId: Sync,
<I as Interner>::Ty: Sync,
<I as Interner>::Const: Sync,
<I as Interner>::Pat: Sync,
<I as Interner>::Region: Sync,
<I as Interner>::BoundExistentialPredicates: Sync,
<I as Interner>::Tys: Sync,
<I as Interner>::ParamTy: Sync,
<I as Interner>::BoundTy: Sync,
<I as Interner>::PlaceholderTy: Sync,
<I as Interner>::ErrorGuaranteed: Sync,
<I as Interner>::BoundVarKinds: Sync,
<I as Interner>::Safety: Sync,
<I as Interner>::Abi: Sync,
impl<I> Unpin for TyKind<I>where
<I as Interner>::AdtDef: Unpin,
<I as Interner>::GenericArgs: Unpin,
<I as Interner>::DefId: Unpin,
<I as Interner>::Ty: Unpin,
<I as Interner>::Const: Unpin,
<I as Interner>::Pat: Unpin,
<I as Interner>::Region: Unpin,
<I as Interner>::BoundExistentialPredicates: Unpin,
<I as Interner>::Tys: Unpin,
<I as Interner>::ParamTy: Unpin,
<I as Interner>::BoundTy: Unpin,
<I as Interner>::PlaceholderTy: Unpin,
<I as Interner>::ErrorGuaranteed: Unpin,
<I as Interner>::BoundVarKinds: Unpin,
<I as Interner>::Safety: Unpin,
<I as Interner>::Abi: Unpin,
impl<I> UnwindSafe for TyKind<I>where
<I as Interner>::AdtDef: UnwindSafe,
<I as Interner>::GenericArgs: UnwindSafe,
<I as Interner>::DefId: UnwindSafe,
<I as Interner>::Ty: UnwindSafe,
<I as Interner>::Const: UnwindSafe,
<I as Interner>::Pat: UnwindSafe,
<I as Interner>::Region: UnwindSafe,
<I as Interner>::BoundExistentialPredicates: UnwindSafe,
<I as Interner>::Tys: UnwindSafe,
<I as Interner>::ParamTy: UnwindSafe,
<I as Interner>::BoundTy: UnwindSafe,
<I as Interner>::PlaceholderTy: UnwindSafe,
<I as Interner>::ErrorGuaranteed: UnwindSafe,
<I as Interner>::BoundVarKinds: UnwindSafe,
<I as Interner>::Safety: UnwindSafe,
<I as Interner>::Abi: UnwindSafe,
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
source§impl<I, T> UpcastFrom<I, T> for T
impl<I, T> UpcastFrom<I, T> for T
fn upcast_from(from: T, _tcx: I) -> T
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
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.