Enum rustc_middle::ty::TyKind

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

Defines the kinds of types.

N.B., if you change this, you’ll probably want to change the corresponding AST structure in rustc_ast/src/ast.rs as well.

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(&'tcx AdtDef, SubstsRef<'tcx>)

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

InternalSubsts here, possibly against intuition, may contain Params. That is, even after substitution it is possible that there are type variables. This happens when the Adt corresponds to an ADT definition and not a concrete use of it.

Foreign(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(Ty<'tcx>, &'tcx Const<'tcx>)

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

Slice(Ty<'tcx>)

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

RawPtr(TypeAndMut<'tcx>)

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

Ref(Region<'tcx>, Ty<'tcx>, Mutability)

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

FnDef(DefId, SubstsRef<'tcx>)

The anonymous type of a function declaration/definition. Each function has a unique type, which is output (for a function named foo returning an i32) as fn() -> i32 {foo}.

For example the type of bar here:

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

FnPtr(PolyFnSig<'tcx>)

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

For example the type of bar here:

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

Dynamic(&'tcx List<Binder<'tcx, ExistentialPredicate<'tcx>>>, Region<'tcx>)

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

Closure(DefId, SubstsRef<'tcx>)

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

Generator(DefId, SubstsRef<'tcx>, Movability)

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

GeneratorWitness(Binder<'tcx, &'tcx List<Ty<'tcx>>>)

A type representing the types stored inside a generator. This should only appear in GeneratorInteriors.

Never

The never type !.

Tuple(SubstsRef<'tcx>)

A tuple type. For example, (i32, bool). Use TyS::tuple_fields to iterate over the field types.

Projection(ProjectionTy<'tcx>)

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

Opaque(DefId, SubstsRef<'tcx>)

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 The substitutions are for the generics of the function in question. After typeck, the concrete type can be found in the types map.

Param(ParamTy)

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

Bound(DebruijnIndex, BoundTy)

Bound type variable, used only when preparing a trait query.

Placeholder(PlaceholderType)

A placeholder type - universally quantified higher-ranked type.

Infer(InferTy)

A type variable used during type checking.

Error(DelaySpanBugEmitted)

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

Implementations

impl<'tcx> TyKind<'tcx>

pub fn is_primitive(&self) -> bool

pub fn article(&self) -> &'static str

Get the article (“a” or “an”) to use with this type.

Trait Implementations

impl<'tcx> Borrow<TyKind<'tcx>> for Interned<'tcx, TyS<'tcx>>

fn borrow<'a>(&'a self) -> &'a TyKind<'tcx>

Immutably borrows from an owned value.

impl<'tcx> Clone for TyKind<'tcx>

fn clone(&self) -> TyKind<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for TyKind<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<'tcx>> Decodable<__D> for TyKind<'tcx>

fn decode(__decoder: &mut __D) -> Result<Self, <__D as Decoder>::Error>

impl<'tcx, __E: TyEncoder<'tcx>> Encodable<__E> for TyKind<'tcx>

fn encode(&self, __encoder: &mut __E) -> Result<(), <__E as Encoder>::Error>

impl<'tcx> Eq for TyKind<'tcx>

impl<'tcx> Hash for TyKind<'tcx>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for TyKind<'tcx>

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx> Ord for TyKind<'tcx>

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'tcx> PartialEq<TyKind<'tcx>> for TyKind<'tcx>

fn eq(&self, other: &TyKind<'tcx>) -> bool

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

fn ne(&self, other: &TyKind<'tcx>) -> bool

This method tests for !=.

impl<'tcx> PartialOrd<TyKind<'tcx>> for TyKind<'tcx>

fn partial_cmp(&self, other: &TyKind<'tcx>) -> Option<Ordering>

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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<'tcx> StructuralEq for TyKind<'tcx>

impl<'tcx> StructuralPartialEq for TyKind<'tcx>