Struct chalk_ir::Ty

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

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>

pub 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, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

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

"Folding" a type invokes the fold_ty method on the folder; this usually (in turn) invokes super_fold_ty to fold the individual parts.

type Result = Ty<I>

The type of value that will be produced once folding is done. Typically this is Self, unless Self contains borrowed values, in which case owned values are produced (for example, one can fold over a &T value where T: Fold, in which case you get back a T, not a &T).

pub fn fold_with<'i>(
    &self,
    folder: &mut dyn Folder<'i, I>,
    outer_binder: DebruijnIndex
) -> Fallible<Self::Result> where
    I: 'i, 

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.

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, 

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: Ord + Interner> Ord for Ty<I> where
    I::InternedType: Ord, 

pub fn cmp(&self, other: &Ty<I>) -> 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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn super_fold_with<'i>(
    &self,
    folder: &mut dyn Folder<'i, I>,
    outer_binder: DebruijnIndex
) -> Fallible<Ty<I>> where
    I: 'i, 

Recursively folds the value.

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

"Super visit" for a type invokes the more detailed callbacks on the type

pub fn super_visit_with<'i, B>(
    &self,
    visitor: &mut dyn Visitor<'i, I, BreakTy = B>,
    outer_binder: DebruijnIndex
) -> ControlFlow<B> where
    I: 'i, 

Recursively visits the type contents.

impl<I: Interner> Visit<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.

pub fn visit_with<'i, B>(
    &self,
    visitor: &mut dyn Visitor<'i, I, BreakTy = B>,
    outer_binder: DebruijnIndex
) -> ControlFlow<B> where
    I: 'i, 

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>

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

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