Struct chalk_ir::Canonical

pub struct Canonical<T: HasInterner> {
    pub value: T,
    pub binders: CanonicalVarKinds<T::Interner>,
}

Wraps a "canonicalized item". Items are canonicalized as follows:

All unresolved existential variables are "renumbered" according to their first appearance; the kind/universe of the variable is recorded in the binders field.

Fields

value: T

The item that is canonicalized.

binders: CanonicalVarKinds<T::Interner>

The kind/universe of the variable.

Implementations

impl<T: HasInterner + Display> Canonical<T>

pub fn display<'a>(
    &'a self,
    interner: &'a T::Interner
) -> CanonicalDisplay<'a, T>

Display the canonicalized item.

Trait Implementations

impl<T, U> CastTo<Canonical<U>> for Canonical<T> where
    T: CastTo<U> + HasInterner,
    U: HasInterner<Interner = T::Interner>, 

fn cast_to(self, interner: &T::Interner) -> Canonical<U>

Cast a value to type T.

impl<T: Clone + HasInterner> Clone for Canonical<T> where
    T::Interner: Clone, 

fn clone(&self) -> Canonical<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + HasInterner> Debug for Canonical<T> where
    T::Interner: Debug, 

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

Formats the value using the given formatter.

impl<T: Eq + HasInterner> Eq for Canonical<T> where
    T::Interner: Eq, 

impl<I, T> Fold<I> for Canonical<T> where
    I: Interner,
    T: HasInterner<Interner = I> + Fold<I>,
    <T as Fold<I>>::Result: HasInterner<Interner = I>, 

type Result = Canonical<T::Result>

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

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<T: HasInterner> HasInterner for Canonical<T>

type Interner = T::Interner

The interner associated with the type.

impl<T: Hash + HasInterner> Hash for Canonical<T> where
    T::Interner: Hash, 

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<T: PartialEq + HasInterner> PartialEq<Canonical<T>> for Canonical<T> where
    T::Interner: PartialEq, 

fn eq(&self, other: &Canonical<T>) -> bool

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

fn ne(&self, other: &Canonical<T>) -> bool

This method tests for !=.

impl<T: HasInterner> StructuralEq for Canonical<T>

impl<T: HasInterner> StructuralPartialEq for Canonical<T>

impl<I, T> Visit<I> for Canonical<T> where
    I: Interner,
    T: HasInterner<Interner = I> + Visit<I>, 

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.