Struct chalk_ir::Ty

pub struct Ty<I: Interner> { /* private fields */ }

A Rust type. The actual type data is stored in TyKind.

Implementations

impl<I: Interner> Ty<I>

pub fn new(interner: I, data: impl CastTo<TyKind<I>>) -> Self

Creates a type from TyKind.

pub fn interned(&self) -> &I::InternedType

Gets the interned type.

pub fn data(&self, interner: I) -> &TyData<I>

Gets the underlying type data.

pub fn kind(&self, interner: I) -> &TyKind<I>

Gets the underlying type kind.

pub fn from_env(&self) -> FromEnv<I>

Creates a FromEnv constraint using this type.

pub fn well_formed(&self) -> WellFormed<I>

Creates a WF-constraint for this type.

pub fn into_from_env_goal(self, interner: I) -> DomainGoal<I>

Creates a domain goal FromEnv(T) where T is this type.

pub fn bound_var(&self, interner: I) -> Option<BoundVar>

If this is a TyKind::BoundVar(d), returns Some(d) else None.

pub fn inference_var(&self, interner: I) -> Option<InferenceVar>

If this is a TyKind::InferenceVar(d), returns Some(d) else None.

pub fn is_general_var(&self, interner: I, binders: &CanonicalVarKinds<I>) -> bool

Returns true if this is a BoundVar or an InferenceVar of TyVariableKind::General.

pub fn is_alias(&self, interner: I) -> bool

Returns true if this is an Alias.

pub fn is_integer(&self, interner: I) -> bool

Returns true if this is an IntTy or UintTy.

pub fn is_float(&self, interner: I) -> bool

Returns true if this is a FloatTy.

pub fn adt_id(&self, interner: I) -> Option<AdtId<I>>

Returns Some(adt_id) if this is an ADT, None otherwise

pub fn needs_shift(&self, interner: I) -> bool

True if this type contains “bound” types/lifetimes, and hence needs to be shifted across binders. This is a very inefficient check, intended only for debug assertions, because I am lazy.

Trait Implementations

impl<I: Interner> CastTo<GenericArg<I>> for Ty<I>

fn cast_to(self, interner: I) -> GenericArg<I>

Cast a value to type T.

impl<I: Clone + Interner> Clone for Ty<I>where
    I::InternedType: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Interner = I

The interner associated with the type.

impl<I: Hash + Interner> Hash for Ty<I>where
    I::InternedType: Hash,

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,

Feeds a slice of this type into the given Hasher.

impl<I: Ord + Interner> Ord for Ty<I>where
    I::InternedType: Ord,

fn cmp(&self, other: &Ty<I>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<I: PartialEq + Interner> PartialEq<Ty<I>> for Ty<I>where
    I::InternedType: PartialEq,

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I: PartialOrd + Interner> PartialOrd<Ty<I>> for Ty<I>where
    I::InternedType: PartialOrd,

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

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

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

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

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

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

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

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

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<I: Interner> TypeFoldable<I> for Ty<I>

“Folding” a type invokes the try_fold_ty method on the folder; this usually (in turn) invokes try_super_fold_ty to fold the individual parts.

fn try_fold_with<E>(
    self,
    folder: &mut dyn FallibleTypeFolder<I, Error = E>,
    outer_binder: DebruijnIndex
) -> Result<Self, E>

Apply the given folder folder to self; binders is the number of binders that are in scope when beginning the folder. Typically binders starts as 0, but is adjusted when we encounter Binders<T> in the IR or other similar constructs.

fn fold_with(
    self,
    folder: &mut dyn TypeFolder<I>,
    outer_binder: DebruijnIndex
) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<I> TypeSuperFoldable<I> for Ty<I>where
    I: Interner,

“Super fold” for a type invokes te more detailed callbacks on the type

fn try_super_fold_with<E>(
    self,
    folder: &mut dyn FallibleTypeFolder<I, Error = E>,
    outer_binder: DebruijnIndex
) -> Result<Ty<I>, E>

Recursively folds the value.

fn super_fold_with(
    self,
    folder: &mut dyn TypeFolder<I>,
    outer_binder: DebruijnIndex
) -> Self

A convenient alternative to try_super_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_super_fold_with.

impl<I> TypeSuperVisitable<I> for Ty<I>where
    I: Interner,

“Super visit” for a type invokes the more detailed callbacks on the type

fn super_visit_with<B>(
    &self,
    visitor: &mut dyn TypeVisitor<I, BreakTy = B>,
    outer_binder: DebruijnIndex
) -> ControlFlow<B>

Recursively visits the type contents.

impl<I: Interner> TypeVisitable<I> for Ty<I>

“visiting” a type invokes the visit_ty method on the visitor; this usually (in turn) invokes super_visit_ty to visit the individual parts.

fn visit_with<B>(
    &self,
    visitor: &mut dyn TypeVisitor<I, BreakTy = B>,
    outer_binder: DebruijnIndex
) -> ControlFlow<B>

Apply the given visitor visitor to self; binders is the number of binders that are in scope when beginning the visitor. Typically binders starts as 0, but is adjusted when we encounter Binders<T> in the IR or other similar constructs.

impl<I: Interner> Zip<I> for Ty<I>

fn zip_with<Z: Zipper<I>>(
    zipper: &mut Z,
    variance: Variance,
    a: &Self,
    b: &Self
) -> Fallible<()>

Uses the zipper to walk through two values, ensuring that they match.

impl<I: Copy + Interner> Copy for Ty<I>where
    I::InternedType: Copy,

impl<I: Eq + Interner> Eq for Ty<I>where
    I::InternedType: Eq,

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

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