Enum TyKind 

pub enum TyKind {
    Scalar(ScalarTy),
    Array(Ty, ConstantExpr, Option<TraitRef>),
    Slice(Ty, Option<TraitRef>),
    Adt(TypeDeclRef),
    Ref(Region, Ty, RefKind),
    RawPtr(Ty, RefKind),
    FnDef(RegionBinder<FnPtr>),
    FnPtr(RegionBinder<FunSig>),
    DynTrait(DynPredicate),
    Pattern(Ty, TypePattern),
    Never,
    TypeVar(TypeDbVar),
    TraitType(TraitRef, AssocTypeId, GenericArgs),
    PtrMetadata(Ty),
    Error(String),
}

A type.

This is interned as Ty, making it cheap to clone and compare.

Variants

Scalar(ScalarTy)

A scalar (integers, floats, char, or bool).

Array(Ty, ConstantExpr, Option<TraitRef>)

An array [T; N]. The third field is the proof that T: Sized; it is absent with --hide-marker-traits.

Slice(Ty, Option<TraitRef>)

A slice [T]. The second field is the proof that T: Sized; it is absent with --hide-marker-traits.

Adt(TypeDeclRef)

An ADT: structs, enums, unions, as well as tuples and str.

Ref(Region, Ty, RefKind)

A reference: &T or &mut T.

RawPtr(Ty, RefKind)

A raw pointer.

FnDef(RegionBinder<FnPtr>)

The unique type associated with each function item. Each function item is given a unique type that has the function’s early-bound generics. This type is not generally nameable in Rust; it’s a ZST (there’s a unique value), and a value of that type can be cast to a function pointer or passed to functions that expect FnOnce/FnMut/Fn parameters.

There’s a binder here because charon function items take both early and late-bound lifetimes as arguments; given that the type we’re pointing to is polymorphic in the late-bound variables, we need to bind them here.

// `'a` is early-bound, 'b is late-bound.
fn foo<'a, 'b>(x: &'a u32, y: &'b u32)
where u32: 'b
{}

For rustc, there’s a ZST foo<'a>, that can be cast to a for<'b> fn(&'a u32, &'b u32) function pointer. For charon, there’s an item foo<'a, 'b>, and the FnDef item that corresponds to rustc’s foo<'a> is represented as FnDef(for<'b> foo<'a, 'b>).

FnPtr(RegionBinder<FunSig>)

Function pointer type. This is a literal pointer to a region of memory that contains a callable function.

A function pointer can have lifetime generics, e.g. for<'a> fn(&'a mut u32) -> &'a u32, hence the binder.

DynTrait(DynPredicate)

dyn Trait: erased value known to implement Trait. A pointer to it will carry a vtable pointer that stores the methods that can be called on this value.

Pattern(Ty, TypePattern)

A pattern type: a type that is representationally identical to its base type, except the only valid values are the ones that match the pattern.

Never

The never type, the canonical uninhabited type.

TypeVar(TypeDbVar)

A type variable.

TraitType(TraitRef, AssocTypeId, GenericArgs)

A trait associated type: <T as Trait>::AssocType<Args>.

PtrMetadata(Ty)

The type of pointer metadata for the given type; e.g. for [T], this type is usize. The way to write this type in Rust is <X as core::ptr::Pointee>::Metadata.

Error(String)

A type that could not be computed or was incorrect.

Implementations

impl TyKind

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

impl TyKind

pub fn is_scalar(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_slice(&self) -> bool

pub fn is_adt(&self) -> bool

pub fn is_ref(&self) -> bool

pub fn is_raw_ptr(&self) -> bool

pub fn is_fn_def(&self) -> bool

pub fn is_fn_ptr(&self) -> bool

pub fn is_dyn_trait(&self) -> bool

pub fn is_pattern(&self) -> bool

pub fn is_never(&self) -> bool

pub fn is_type_var(&self) -> bool

pub fn is_trait_type(&self) -> bool

pub fn is_ptr_metadata(&self) -> bool

pub fn is_error(&self) -> bool

impl TyKind

pub fn as_scalar(&self) -> Option<&ScalarTy>

pub fn as_array(&self) -> Option<(&Ty, &ConstantExpr, &Option<TraitRef>)>

pub fn as_slice(&self) -> Option<(&Ty, &Option<TraitRef>)>

pub fn as_adt(&self) -> Option<&TypeDeclRef>

pub fn as_ref(&self) -> Option<(&Region, &Ty, &RefKind)>

pub fn as_raw_ptr(&self) -> Option<(&Ty, &RefKind)>

pub fn as_fn_def(&self) -> Option<&RegionBinder<FnPtr>>

pub fn as_fn_ptr(&self) -> Option<&RegionBinder<FunSig>>

pub fn as_dyn_trait(&self) -> Option<&DynPredicate>

pub fn as_pattern(&self) -> Option<(&Ty, &TypePattern)>

pub fn as_never(&self) -> Option<()>

pub fn as_type_var(&self) -> Option<&TypeDbVar>

pub fn as_trait_type(&self) -> Option<(&TraitRef, &AssocTypeId, &GenericArgs)>

pub fn as_ptr_metadata(&self) -> Option<&Ty>

pub fn as_error(&self) -> Option<&String>

impl TyKind

pub fn as_scalar_mut(&mut self) -> Option<&mut ScalarTy>

pub fn as_array_mut( &mut self, ) -> Option<(&mut Ty, &mut ConstantExpr, &mut Option<TraitRef>)>

pub fn as_slice_mut(&mut self) -> Option<(&mut Ty, &mut Option<TraitRef>)>

pub fn as_adt_mut(&mut self) -> Option<&mut TypeDeclRef>

pub fn as_ref_mut(&mut self) -> Option<(&mut Region, &mut Ty, &mut RefKind)>

pub fn as_raw_ptr_mut(&mut self) -> Option<(&mut Ty, &mut RefKind)>

pub fn as_fn_def_mut(&mut self) -> Option<&mut RegionBinder<FnPtr>>

pub fn as_fn_ptr_mut(&mut self) -> Option<&mut RegionBinder<FunSig>>

pub fn as_dyn_trait_mut(&mut self) -> Option<&mut DynPredicate>

pub fn as_pattern_mut(&mut self) -> Option<(&mut Ty, &mut TypePattern)>

pub fn as_never_mut(&mut self) -> Option<()>

pub fn as_type_var_mut(&mut self) -> Option<&mut TypeDbVar>

pub fn as_trait_type_mut( &mut self, ) -> Option<(&mut TraitRef, &mut AssocTypeId, &mut GenericArgs)>

pub fn as_ptr_metadata_mut(&mut self) -> Option<&mut Ty>

pub fn as_error_mut(&mut self) -> Option<&mut String>

impl TyKind

pub fn to_scalar(self) -> Option<ScalarTy>

pub fn to_array(self) -> Option<(Ty, ConstantExpr, Option<TraitRef>)>

pub fn to_slice(self) -> Option<(Ty, Option<TraitRef>)>

pub fn to_adt(self) -> Option<TypeDeclRef>

pub fn to_ref(self) -> Option<(Region, Ty, RefKind)>

pub fn to_raw_ptr(self) -> Option<(Ty, RefKind)>

pub fn to_fn_def(self) -> Option<RegionBinder<FnPtr>>

pub fn to_fn_ptr(self) -> Option<RegionBinder<FunSig>>

pub fn to_dyn_trait(self) -> Option<DynPredicate>

pub fn to_pattern(self) -> Option<(Ty, TypePattern)>

pub fn to_never(self) -> Option<()>

pub fn to_type_var(self) -> Option<TypeDbVar>

pub fn to_trait_type(self) -> Option<(TraitRef, AssocTypeId, GenericArgs)>

pub fn to_ptr_metadata(self) -> Option<Ty>

pub fn to_error(self) -> Option<String>

impl TyKind

pub fn variant_index_arity(&self) -> (u32, usize)

impl TyKind

pub fn into_ty(self) -> Ty

pub fn is_usize(&self) -> bool

pub fn is_unsigned_scalar(&self) -> bool

pub fn is_signed_scalar(&self) -> bool

pub fn is_str(&self) -> bool

pub fn is_box(&self) -> bool

Return true if the type is Box

pub fn is_tuple(&self) -> bool

pub fn as_adt_id(&self) -> Option<TypeDeclId>

pub fn as_box(&self) -> Option<&Ty>

pub fn as_box_mut(&mut self) -> Option<&mut Ty>

pub fn builtin_deref(&self) -> Option<&Ty>

pub fn builtin_deref_mut(&mut self) -> Option<&mut Ty>

pub fn as_array_or_slice(&self) -> Option<&Ty>

pub fn as_array_or_slice_mut(&mut self) -> Option<&mut Ty>

Trait Implementations

impl AstVisitable for TyKind

fn drive<V: VisitAst>(&self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive_mut<V: VisitAstMut>(&mut self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn name(&self) -> &'static str

The name of the type, used for debug logging.

fn dyn_visit<T: AstVisitable>(&self, f: impl FnMut(&T))

where Self: Sized,

Visit all occurrences of that type inside self, in pre-order traversal.

fn dyn_visit_mut<T: AstVisitable>(&mut self, f: impl FnMut(&mut T))

where Self: Sized,

Visit all occurrences of that type inside self, in pre-order traversal.

impl Clone for TyKind

fn clone(&self) -> TyKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TyKind

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

Formats the value using the given formatter.

impl<'de, __State: ?Sized> DeserializeState<'de, __State> for TyKind

where ScalarTy: DeserializeState<'de, __State>, Ty: DeserializeState<'de, __State>, ConstantExpr: DeserializeState<'de, __State>, Option<TraitRef>: DeserializeState<'de, __State>, TypeDeclRef: DeserializeState<'de, __State>, Region: DeserializeState<'de, __State>, RefKind: DeserializeState<'de, __State>, RegionBinder<FnPtr>: DeserializeState<'de, __State>, RegionBinder<FunSig>: DeserializeState<'de, __State>, DynPredicate: DeserializeState<'de, __State>, TypePattern: DeserializeState<'de, __State>, TypeDbVar: DeserializeState<'de, __State>, TraitRef: DeserializeState<'de, __State>, AssocTypeId: DeserializeState<'de, __State>, GenericArgs: DeserializeState<'de, __State>, String: DeserializeState<'de, __State>,

fn deserialize_state<__D>( __state: &__State, __deserializer: __D, ) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

impl<'s, V> Drive<'s, V> for TyKind

where V: Visitor + Visit<'s, ScalarTy> + Visit<'s, Ty> + Visit<'s, ConstantExpr> + Visit<'s, Option<TraitRef>> + Visit<'s, TypeDeclRef> + Visit<'s, Region> + Visit<'s, RefKind> + Visit<'s, RegionBinder<FnPtr>> + Visit<'s, RegionBinder<FunSig>> + Visit<'s, DynPredicate> + Visit<'s, TypePattern> + Visit<'s, TypeDbVar> + Visit<'s, TraitRef> + Visit<'s, AssocTypeId> + Visit<'s, GenericArgs> + Visit<'s, String>,

fn drive_inner(&'s self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl<'s, V> DriveMut<'s, V> for TyKind

where V: Visitor + VisitMut<'s, ScalarTy> + VisitMut<'s, Ty> + VisitMut<'s, ConstantExpr> + VisitMut<'s, Option<TraitRef>> + VisitMut<'s, TypeDeclRef> + VisitMut<'s, Region> + VisitMut<'s, RefKind> + VisitMut<'s, RegionBinder<FnPtr>> + VisitMut<'s, RegionBinder<FunSig>> + VisitMut<'s, DynPredicate> + VisitMut<'s, TypePattern> + VisitMut<'s, TypeDbVar> + VisitMut<'s, TraitRef> + VisitMut<'s, AssocTypeId> + VisitMut<'s, GenericArgs> + VisitMut<'s, String>,

fn drive_inner_mut(&'s mut self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl<'s, V> DriveTwo<'s, V> for TyKind

where V: Visitor<Break: Default> + VisitTwo<'s, ScalarTy> + VisitTwo<'s, Ty> + VisitTwo<'s, ConstantExpr> + VisitTwo<'s, Option<TraitRef>> + VisitTwo<'s, TypeDeclRef> + VisitTwo<'s, Region> + VisitTwo<'s, RefKind> + VisitTwo<'s, RegionBinder<FnPtr>> + VisitTwo<'s, RegionBinder<FunSig>> + VisitTwo<'s, DynPredicate> + VisitTwo<'s, TypePattern> + VisitTwo<'s, TypeDbVar> + VisitTwo<'s, TraitRef> + VisitTwo<'s, AssocTypeId> + VisitTwo<'s, GenericArgs> + VisitTwo<'s, String>,

fn drive_two_inner( &'s self, other: &'s Self, visitor: &mut V, ) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self and other, if they correspond. If the values don’t match up, this returns Break(Default::default()).

impl Eq for TyKind

impl From<DeBruijnVar<TypeVarId>> for TyKind

fn from(x: TypeDbVar) -> Self

Converts to this type from the input type.

impl From<TyKind> for Ty

fn from(kind: TyKind) -> Ty

Converts to this type from the input type.

impl Hash for TyKind

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TyKind

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TyKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TyKind

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<__State: ?Sized> SerializeState<__State> for TyKind

where ScalarTy: SerializeState<__State>, Ty: SerializeState<__State>, ConstantExpr: SerializeState<__State>, Option<TraitRef>: SerializeState<__State>, TypeDeclRef: SerializeState<__State>, Region: SerializeState<__State>, RefKind: SerializeState<__State>, RegionBinder<FnPtr>: SerializeState<__State>, RegionBinder<FunSig>: SerializeState<__State>, DynPredicate: SerializeState<__State>, TypePattern: SerializeState<__State>, TypeDbVar: SerializeState<__State>, TraitRef: SerializeState<__State>, AssocTypeId: SerializeState<__State>, GenericArgs: SerializeState<__State>, String: SerializeState<__State>,

fn serialize_state<__S>( &self, __state: &__State, __serializer: __S, ) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

impl StructuralPartialEq for TyKind

impl TryFrom<TyKind> for TypeDbVar

type Error = ()

The type returned in the event of a conversion error.

fn try_from(e: TyKind) -> Result<Self, Self::Error>

Performs the conversion.