Type Alias TyKind

pub type TyKind = TyKind<Interner>;

Aliased Type

enum TyKind {
    Adt(AdtId<Interner>, Substitution<Interner>),
    AssociatedType(AssocTypeId<Interner>, Substitution<Interner>),
    Scalar(Scalar),
    Tuple(usize, Substitution<Interner>),
    Array(Ty<Interner>, Const<Interner>),
    Slice(Ty<Interner>),
    Raw(Mutability, Ty<Interner>),
    Ref(Mutability, Lifetime<Interner>, Ty<Interner>),
    OpaqueType(OpaqueTyId<Interner>, Substitution<Interner>),
    FnDef(FnDefId<Interner>, Substitution<Interner>),
    Str,
    Never,
    Closure(ClosureId<Interner>, Substitution<Interner>),
    Coroutine(CoroutineId<Interner>, Substitution<Interner>),
    CoroutineWitness(CoroutineId<Interner>, Substitution<Interner>),
    Foreign(ForeignDefId<Interner>),
    Error,
    Placeholder(PlaceholderIndex),
    Dyn(DynTy<Interner>),
    Alias(AliasTy<Interner>),
    Function(FnPointer<Interner>),
    BoundVar(BoundVar),
    InferenceVar(InferenceVar, TyVariableKind),
}

Variants

Adt(AdtId<Interner>, Substitution<Interner>)

Abstract data types, i.e., structs, unions, or enumerations. For example, a type like Vec<T>.

AssociatedType(AssocTypeId<Interner>, Substitution<Interner>)

an associated type like Iterator::Item; see AssociatedType for details

Scalar(Scalar)

a scalar type like bool or u32

Tuple(usize, Substitution<Interner>)

a tuple of the given arity

Array(Ty<Interner>, Const<Interner>)

an array type like [T; N]

Slice(Ty<Interner>)

a slice type like [T]

Raw(Mutability, Ty<Interner>)

a raw pointer type like *const T or *mut T

Ref(Mutability, Lifetime<Interner>, Ty<Interner>)

a reference type like &T or &mut T

OpaqueType(OpaqueTyId<Interner>, Substitution<Interner>)

a placeholder for opaque types like impl Trait

FnDef(FnDefId<Interner>, Substitution<Interner>)

a function definition

Str

the string primitive type

Never

the never type !

Closure(ClosureId<Interner>, Substitution<Interner>)

A closure.

Coroutine(CoroutineId<Interner>, Substitution<Interner>)

A coroutine.

CoroutineWitness(CoroutineId<Interner>, Substitution<Interner>)

A coroutine witness.

Foreign(ForeignDefId<Interner>)

foreign types

Error

This can be used to represent an error, e.g. during name resolution of a type. Chalk itself will not produce this, just pass it through when given.

Placeholder(PlaceholderIndex)

instantiated from a universally quantified type, e.g., from forall<T> { .. }. Stands in as a representative of “some unknown type”.

Dyn(DynTy<Interner>)

A “dyn” type is a trait object type created via the “dyn Trait” syntax. In the chalk parser, the traits that the object represents is parsed as a QuantifiedInlineBound, and is then changed to a list of where clauses during lowering.

See the Opaque variant for a discussion about the use of binders here.

Alias(AliasTy<Interner>)

An “alias” type represents some form of type alias, such as:

• An associated type projection like <T as Iterator>::Item
• impl Trait types
• Named type aliases like type Foo<X> = Vec<X>

Function(FnPointer<Interner>)

A function type such as for<'a> fn(&'a u32). Note that “higher-ranked” types (starting with for<>) are either function types or dyn types, and do not appear otherwise in Rust surface syntax.

BoundVar(BoundVar)

References the binding at the given depth. The index is a [de Bruijn index], so it counts back through the in-scope binders.

InferenceVar(InferenceVar, TyVariableKind)

Inference variable defined in the current inference context.

Implementations

impl<I> TyKind<I>

where I: Interner,

pub fn debug(&self, interner: I) -> TyKindDebug<'_, I>

Show debug output for the application type.

impl<I> TyKind<I>

where I: Interner,

pub fn intern(self, interner: I) -> Ty<I>

Casts the type data to a type.

pub fn compute_flags(&self, interner: I) -> TypeFlags

Compute type flags for a TyKind

Trait Implementations

impl<I> CastTo<TyKind<I>> for TyKind<I>

where I: Interner,

fn cast_to(self, _interner: <TyKind<I> as HasInterner>::Interner) -> TyKind<I>

Cast a value to type T.

impl<I> Clone for TyKind<I>

where I: Clone + Interner,

fn clone(&self) -> TyKind<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for TyKind<I>

where I: Interner,

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

Formats the value using the given formatter.

impl<I> HasInterner for TyKind<I>

where I: Interner,

type Interner = I

The interner associated with the type.

impl<I> Hash for TyKind<I>

where I: Hash + Interner,

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I> PartialEq for TyKind<I>

where I: PartialEq + Interner,

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

where I: Interner, <I as Interner>::InternedLifetime: Copy, <I as Interner>::InternedSubstitution: Copy, <I as Interner>::InternedVariableKinds: Copy, <I as Interner>::InternedQuantifiedWhereClauses: Copy, <I as Interner>::InternedType: Copy, <I as Interner>::InternedConst: Copy,

impl<I> Eq for TyKind<I>

where I: Eq + Interner,

impl<I> StructuralPartialEq for TyKind<I>

where I: Interner,