Enum chalk_ir::TyKind

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

Type data, which holds the actual type information.

Variants

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

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

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

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

Scalar(Scalar)

a scalar type like bool or u32

Tuple(usize, Substitution<I>)

a tuple of the given arity

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

an array type like [T; N]

Slice(Ty<I>)

a slice type like [T]

Raw(Mutability, Ty<I>)

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

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

a reference type like &T or &mut T

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

a placeholder for opaque types like impl Trait

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

a function definition

Str

the string primitive type

Never

the never type !

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

A closure.

Generator(GeneratorId<I>, Substitution<I>)

A generator.

GeneratorWitness(GeneratorId<I>, Substitution<I>)

A generator witness.

Foreign(ForeignDefId<I>)

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<I>)

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<I>)

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<I>)

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: Interner> TyKind<I>

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

Show debug output for the application type.

impl<I: Interner> TyKind<I>

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

Casts the type data to a type.

Trait Implementations

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

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

Cast a value to type T.

impl<I: Interner> CastTo<TyKind<I>> for AliasTy<I>

pub fn cast_to(self, _interner: &I) -> TyKind<I>

Cast a value to type T.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Interner> Copy for TyKind<I> where
    I::InternedLifetime: Copy,
    I::InternedSubstitution: Copy,
    I::InternedVariableKinds: Copy,
    I::InternedQuantifiedWhereClauses: Copy,
    I::InternedType: Copy,
    I::InternedConst: Copy, 

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

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

Formats the value using the given formatter.

impl<I: Eq + Interner> Eq for TyKind<I>

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

type Interner = I

The interner associated with the type.

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

pub 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<I: PartialEq + Interner> PartialEq<TyKind<I>> for TyKind<I>

pub fn eq(&self, other: &TyKind<I>) -> bool

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

pub fn ne(&self, other: &TyKind<I>) -> bool

This method tests for !=.

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

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