Struct chalk_ir::Binders

pub struct Binders<T: HasInterner> {
    pub binders: VariableKinds<T::Interner>,
    // some fields omitted
}

Indicates that the value is universally quantified over N parameters of the given kinds, where N == self.binders.len(). A variable with depth i < N refers to the value at self.binders[i]. Variables with depth >= N are free.

(IOW, we use deBruijn indices, where binders are introduced in reverse order of self.binders.)

Fields

binders: VariableKinds<T::Interner>

The binders that quantify over the value.

Implementations

impl<I: Interner> Binders<WhereClause<I>>

pub fn into_well_formed_goal(self, interner: &I) -> Binders<DomainGoal<I>>

As with WhereClause::into_well_formed_goal, but for a quantified where clause. For example, forall<T> { Implemented(T: Trait)} would map to forall<T> { WellFormed(T: Trait) }.

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

As with WhereClause::into_from_env_goal, but mapped over any binders. For example, forall<T> { Implemented(T: Trait)} would map to forall<T> { FromEnv(T: Trait) }.

pub fn trait_id(&self) -> Option<TraitId<I>>

If the underlying where clause is a TraitRef, returns its trait id.

impl<T: HasInterner> Binders<T>

pub fn new(binders: VariableKinds<T::Interner>, value: T) -> Self

Create new binders.

pub fn empty(interner: &T::Interner, value: T) -> Self

Wraps the given value in a binder without variables, i.e. for<> (value). Since our deBruijn indices count binders, not variables, this is sometimes useful.

pub fn skip_binders(&self) -> &T

Skips the binder and returns the "bound" value. This is a risky thing to do because it's easy to get confused about De Bruijn indices and the like. skip_binder is only valid when you are either extracting data that has nothing to do with bound vars, or you are being very careful about your depth accounting.

Some examples where skip_binder is reasonable:

• extracting the TraitId from a TraitRef;
• checking if there are any fields in a StructDatum

pub fn as_ref(&self) -> Binders<&T>

Converts &Binders<T> to Binders<&T>. Produces new Binders with cloned quantifiers containing a reference to the original value, leaving the original in place.

pub fn map<U, OP>(self, op: OP) -> Binders<U> where
    OP: FnOnce(T) -> U,
    U: HasInterner<Interner = T::Interner>, 

Maps the binders by applying a function.

pub fn filter_map<U, OP>(self, op: OP) -> Option<Binders<U>> where
    OP: FnOnce(T) -> Option<U>,
    U: HasInterner<Interner = T::Interner>, 

Transforms the inner value according to the given function; returns None if the function returns None.

pub fn map_ref<'a, U, OP>(&'a self, op: OP) -> Binders<U> where
    OP: FnOnce(&'a T) -> U,
    U: HasInterner<Interner = T::Interner>, 

Maps a function taking Binders<&T> over &Binders<T>.

pub fn identity_substitution(
    &self,
    interner: &T::Interner
) -> Substitution<T::Interner>

Creates a Substitution containing bound vars such that applying this substitution will not change the value, i.e. ^0.0, ^0.1, ^0.2 and so on.

pub fn with_fresh_type_var(
    interner: &T::Interner,
    op: impl FnOnce(Ty<T::Interner>) -> T
) -> Binders<T>

Creates a fresh binders that contains a single type variable. The result of the closure will be embedded in this binder. Note that you should be careful with what you return from the closure to account for the binder that will be added.

XXX FIXME -- this is potentially a pretty footgun-y function.

pub fn len(&self, interner: &T::Interner) -> usize

Returns the number of binders.

impl<T, I> Binders<Binders<T>> where
    T: Fold<I> + HasInterner<Interner = I>,
    T::Result: HasInterner<Interner = I>,
    I: Interner, 

pub fn fuse_binders(self, interner: &T::Interner) -> Binders<T::Result>

This turns two levels of binders (for<A> for<B>) into one level (for<A, B>).

impl<T, I> Binders<T> where
    T: Fold<I> + HasInterner<Interner = I>,
    I: Interner, 

pub fn substitute(
    &self,
    interner: &I,
    parameters: &impl AsParameters<I> + ?Sized
) -> T::Result

Substitute parameters for the variables introduced by these binders. So if the binders represent (e.g.) <X, Y> { T } and parameters is the slice [A, B], then returns [X => A, Y => B] T.

Trait Implementations

impl<I: Interner> CastTo<Binders<WhereClause<I>>> for QuantifiedWhereClause<I>

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

Cast a value to type T.

impl<I: Interner, T: HasInterner<Interner = I> + CastTo<Goal<I>>> CastTo<Goal<I>> for Binders<T>

pub fn cast_to(self, interner: &I) -> Goal<I>

Cast a value to type T.

impl<I, T> CastTo<ProgramClause<I>> for Binders<T> where
    I: Interner,
    T: HasInterner<Interner = I> + CastTo<DomainGoal<I>>, 

pub fn cast_to(self, interner: &I) -> ProgramClause<I>

Cast a value to type T.

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

pub fn clone(&self) -> Binders<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: HasInterner + Copy> Copy for Binders<T> where
    <T::Interner as Interner>::InternedVariableKinds: Copy, 

impl<T: HasInterner + Debug> Debug for Binders<T>

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

Formats the value using the given formatter.

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

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

type Result = Binders<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).

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<T: HasInterner> From<Binders<T>> for (VariableKinds<T::Interner>, T)

pub fn from(binders: Binders<T>) -> Self

Performs the conversion.

impl<T: HasInterner> HasInterner for Binders<T>

type Interner = T::Interner

The interner associated with the type.

impl<T: Hash + HasInterner> Hash for Binders<T> where
    T::Interner: 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<V, U> IntoIterator for Binders<V> where
    V: HasInterner + IntoIterator<Item = U>,
    U: HasInterner<Interner = V::Interner>, 

Allows iterating over a Binders<Vec>, for instance. Each element will include the same set of parameter bounds.

type Item = Binders<U>

The type of the elements being iterated over.

type IntoIter = BindersIntoIterator<V>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq + HasInterner> PartialEq<Binders<T>> for Binders<T> where
    T::Interner: PartialEq, 

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

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

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

This method tests for !=.

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

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

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

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, T: HasInterner<Interner = I> + Zip<I> + Fold<I, Result = T>> Zip<I> for Binders<T>

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.