Struct Binder

pub struct Binder<I: Interner, T> {
    value: T,
    bound_vars: I::BoundVarKinds,
}

Binder is a binder for higher-ranked lifetimes or types. It is part of the compiler’s representation for things like for<'a> Fn(&'a isize) (which would be represented by the type PolyTraitRef == Binder<I, TraitRef>). Note that when we instantiate, erase, or otherwise “discharge” these bound vars, we change the type from Binder<I, T> to just T (see e.g., liberate_late_bound_regions).

Decodable and Encodable are implemented for Binder<T> using the impl_binder_encode_decode! macro.

Fields

value: T

bound_vars: I::BoundVarKinds

Implementations

impl<I: Interner, T> Binder<I, T>

where T: TypeVisitable<I>,

pub fn dummy(value: T) -> Binder<I, T>

Wraps value in a binder, asserting that value does not contain any bound vars that would be bound by the binder. This is commonly used to ‘inject’ a value T into a different binding level.

pub fn bind_with_vars(value: T, bound_vars: I::BoundVarKinds) -> Binder<I, T>

impl<I: Interner, T> Binder<I, T>

pub fn skip_binder(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. It is usually better to discharge the binder using no_bound_vars or instantiate_bound_regions or something like that. skip_binder is only valid when you are either extracting data that has nothing to do with bound vars, you are doing some sort of test that does not involve bound regions, or you are being very careful about your depth accounting.

Some examples where skip_binder is reasonable:

• extracting the DefId from a PolyTraitRef;
• comparing the self type of a PolyTraitRef to see if it is equal to a type parameter X, since the type X does not reference any regions

pub fn bound_vars(&self) -> I::BoundVarKinds

pub fn as_ref(&self) -> Binder<I, &T>

pub fn as_deref(&self) -> Binder<I, &T::Target>

where T: Deref,

pub fn map_bound_ref<F, U: TypeVisitable<I>>(&self, f: F) -> Binder<I, U>

where F: FnOnce(&T) -> U,

pub fn map_bound<F, U: TypeVisitable<I>>(self, f: F) -> Binder<I, U>

where F: FnOnce(T) -> U,

pub fn try_map_bound<F, U: TypeVisitable<I>, E>( self, f: F, ) -> Result<Binder<I, U>, E>

where F: FnOnce(T) -> Result<U, E>,

pub fn rebind<U>(&self, value: U) -> Binder<I, U>

where U: TypeVisitable<I>,

Wraps a value in a binder, using the same bound variables as the current Binder. This should not be used if the new value changes the bound variables. Note: the (old or new) value itself does not necessarily need to name all the bound variables.

This currently doesn’t do anything different than bind, because we don’t actually track bound vars. However, semantically, it is different because bound vars aren’t allowed to change here, whereas they are in bind. This may be (debug) asserted in the future.

pub fn no_bound_vars(self) -> Option<T>

where T: TypeVisitable<I>,

Unwraps and returns the value within, but only if it contains no bound vars at all. (In other words, if this binder – and indeed any enclosing binder – doesn’t bind anything at all.) Otherwise, returns None.

(One could imagine having a method that just unwraps a single binder, but permits late-bound vars bound by enclosing binders, but that would require adjusting the debruijn indices, and given the shallow binding structure we often use, would not be that useful.)

impl<I: Interner, T> Binder<I, Option<T>>

pub fn transpose(self) -> Option<Binder<I, T>>

impl<I: Interner, T: IntoIterator> Binder<I, T>

pub fn iter(self) -> impl Iterator<Item = Binder<I, T::Item>>

impl<I: Interner> Binder<I, TraitRef<I>>

pub fn self_ty(&self) -> Binder<I, I::Ty>

pub fn def_id(&self) -> I::DefId

pub fn to_host_effect_clause(self, cx: I, host: HostPolarity) -> I::Clause

impl<I: Interner> Binder<I, TraitPredicate<I>>

pub fn def_id(self) -> I::DefId

pub fn self_ty(self) -> Binder<I, I::Ty>

pub fn polarity(self) -> PredicatePolarity

impl<I: Interner> Binder<I, ExistentialPredicate<I>>

pub fn with_self_ty(&self, cx: I, self_ty: I::Ty) -> I::Clause

Given an existential predicate like ?Self: PartialEq<u32> (e.g., derived from dyn PartialEq<u32>), and a concrete type self_ty, returns a full predicate where the existentially quantified variable ?Self has been replaced with self_ty (e.g., self_ty: PartialEq<u32>, in our example).

impl<I: Interner> Binder<I, ExistentialTraitRef<I>>

pub fn def_id(&self) -> I::DefId

pub fn with_self_ty(&self, cx: I, self_ty: I::Ty) -> Binder<I, TraitRef<I>>

Object types don’t have a self type specified. Therefore, when we convert the principal trait-ref into a normal trait-ref, you must give some self type. A common choice is mk_err() or some placeholder type.

impl<I: Interner> Binder<I, ExistentialProjection<I>>

pub fn with_self_ty( &self, cx: I, self_ty: I::Ty, ) -> Binder<I, ProjectionPredicate<I>>

pub fn item_def_id(&self) -> I::DefId

impl<I: Interner> Binder<I, ProjectionPredicate<I>>

pub fn trait_def_id(&self, cx: I) -> I::DefId

Returns the DefId of the trait of the associated item being projected.

pub fn required_poly_trait_ref(&self, cx: I) -> Binder<I, TraitRef<I>>

Get the trait ref required for this projection to be well formed. Note that for generic associated types the predicates of the associated type also need to be checked.

pub fn term(&self) -> Binder<I, I::Term>

pub fn projection_def_id(&self) -> I::DefId

The DefId of the TraitItem for the associated type.

Note that this is not the DefId of the TraitRef containing this associated type, which is in tcx.associated_item(projection_def_id()).container.

impl<I: Interner> Binder<I, HostEffectPredicate<I>>

pub fn def_id(self) -> I::DefId

pub fn self_ty(self) -> Binder<I, I::Ty>

pub fn host(self) -> HostPolarity

impl<I: Interner> Binder<I, FnSig<I>>

pub fn inputs(self) -> Binder<I, I::FnInputTys>

pub fn input(self, index: usize) -> Binder<I, I::Ty>

pub fn inputs_and_output(self) -> Binder<I, I::Tys>

pub fn output(self) -> Binder<I, I::Ty>

pub fn c_variadic(self) -> bool

pub fn safety(self) -> I::Safety

pub fn abi(self) -> I::Abi

pub fn is_fn_trait_compatible(&self) -> bool

pub fn split(self) -> (Binder<I, FnSigTys<I>>, FnHeader<I>)

impl<I: Interner> Binder<I, FnSigTys<I>>

pub fn with(self, hdr: FnHeader<I>) -> Binder<I, FnSig<I>>

pub fn inputs(self) -> Binder<I, I::FnInputTys>

pub fn input(self, index: usize) -> Binder<I, I::Ty>

pub fn inputs_and_output(self) -> Binder<I, I::Tys>

pub fn output(self) -> Binder<I, I::Ty>

Trait Implementations

impl<I, T> Clone for Binder<I, T>

where I: Interner, T: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I, T> Debug for Binder<I, T>

where I: Interner, T: Debug,

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

Formats the value using the given formatter.

impl<I: Interner, D: TyDecoder<I = I>> Decodable<D> for Binder<I, ExistentialPredicate<I>>

where ExistentialPredicate<I>: TypeVisitable<I> + Decodable<D>, I::BoundVarKinds: Decodable<D>,

fn decode(decoder: &mut D) -> Self

impl<I: Interner, D: TyDecoder<I = I>> Decodable<D> for Binder<I, ExistentialTraitRef<I>>

where ExistentialTraitRef<I>: TypeVisitable<I> + Decodable<D>, I::BoundVarKinds: Decodable<D>,

fn decode(decoder: &mut D) -> Self

impl<I: Interner, D: TyDecoder<I = I>> Decodable<D> for Binder<I, FnSig<I>>

where FnSig<I>: TypeVisitable<I> + Decodable<D>, I::BoundVarKinds: Decodable<D>,

fn decode(decoder: &mut D) -> Self

impl<I: Interner, D: TyDecoder<I = I>> Decodable<D> for Binder<I, FnSigTys<I>>

where FnSigTys<I>: TypeVisitable<I> + Decodable<D>, I::BoundVarKinds: Decodable<D>,

fn decode(decoder: &mut D) -> Self

impl<I: Interner, D: TyDecoder<I = I>> Decodable<D> for Binder<I, TraitPredicate<I>>

where TraitPredicate<I>: TypeVisitable<I> + Decodable<D>, I::BoundVarKinds: Decodable<D>,

fn decode(decoder: &mut D) -> Self

impl<I: Interner, D: TyDecoder<I = I>> Decodable<D> for Binder<I, TraitRef<I>>

where TraitRef<I>: TypeVisitable<I> + Decodable<D>, I::BoundVarKinds: Decodable<D>,

fn decode(decoder: &mut D) -> Self

impl<I, T> Display for Binder<I, T>

where I: IrPrint<Binder<I, T>> + Interner,

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

Formats the value using the given formatter.

impl<I: Interner, E: TyEncoder<I = I>> Encodable<E> for Binder<I, ExistentialPredicate<I>>

where ExistentialPredicate<I>: Encodable<E>, I::BoundVarKinds: Encodable<E>,

fn encode(&self, e: &mut E)

impl<I: Interner, E: TyEncoder<I = I>> Encodable<E> for Binder<I, ExistentialTraitRef<I>>

where ExistentialTraitRef<I>: Encodable<E>, I::BoundVarKinds: Encodable<E>,

fn encode(&self, e: &mut E)

impl<I: Interner, E: TyEncoder<I = I>> Encodable<E> for Binder<I, FnSig<I>>

where FnSig<I>: Encodable<E>, I::BoundVarKinds: Encodable<E>,

fn encode(&self, e: &mut E)

impl<I: Interner, E: TyEncoder<I = I>> Encodable<E> for Binder<I, FnSigTys<I>>

where FnSigTys<I>: Encodable<E>, I::BoundVarKinds: Encodable<E>,

fn encode(&self, e: &mut E)

impl<I: Interner, E: TyEncoder<I = I>> Encodable<E> for Binder<I, TraitPredicate<I>>

where TraitPredicate<I>: Encodable<E>, I::BoundVarKinds: Encodable<E>,

fn encode(&self, e: &mut E)

impl<I: Interner, E: TyEncoder<I = I>> Encodable<E> for Binder<I, TraitRef<I>>

where TraitRef<I>: Encodable<E>, I::BoundVarKinds: Encodable<E>,

fn encode(&self, e: &mut E)

impl<I, T> Hash for Binder<I, T>

where I: Interner, T: 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I: Interner, T, __CTX> HashStable<__CTX> for Binder<I, T>

where T: HashStable<__CTX>, I::BoundVarKinds: HashStable<__CTX>,

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

impl<I: Interner, U: Interner, T> Lift<U> for Binder<I, T>

where T: Lift<U>, I::BoundVarKinds: Lift<U, Lifted = U::BoundVarKinds>,

type Lifted = Binder<U, <T as Lift<U>>::Lifted>

fn lift_to_interner(self, cx: U) -> Option<Self::Lifted>

impl<I, T> PartialEq for Binder<I, T>

where I: Interner, T: PartialEq,

fn eq(&self, __other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<I: Interner, T: Relate<I>> Relate<I> for Binder<I, T>

fn relate<R: TypeRelation<I>>( relation: &mut R, a: Binder<I, T>, b: Binder<I, T>, ) -> RelateResult<I, Binder<I, T>>

impl<I: Interner, T: TypeFoldable<I>> TypeFoldable<I> for Binder<I, T>

fn try_fold_with<F: FallibleTypeFolder<I>>( self, folder: &mut F, ) -> Result<Self, F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

fn fold_with<F: TypeFolder<I>>(self, folder: &mut F) -> 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: Interner, T: TypeFoldable<I>> TypeSuperFoldable<I> for Binder<I, T>

fn try_super_fold_with<F: FallibleTypeFolder<I>>( self, folder: &mut F, ) -> Result<Self, F::Error>

Provides a default fold for a recursive type of interest. This should only be called within TypeFolder methods, when a non-custom traversal is desired for the value of the type of interest passed to that method. For example, in MyFolder::try_fold_ty(ty), it is valid to call ty.try_super_fold_with(self), but any other folding should be done with xyz.try_fold_with(self).

fn super_fold_with<F: TypeFolder<I>>(self, folder: &mut F) -> 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: Interner, T: TypeVisitable<I>> TypeSuperVisitable<I> for Binder<I, T>

fn super_visit_with<V: TypeVisitor<I>>(&self, visitor: &mut V) -> V::Result

Provides a default visit for a recursive type of interest. This should only be called within TypeVisitor methods, when a non-custom traversal is desired for the value of the type of interest passed to that method. For example, in MyVisitor::visit_ty(ty), it is valid to call ty.super_visit_with(self), but any other visiting should be done with xyz.visit_with(self).

impl<I: Interner, T: TypeVisitable<I>> TypeVisitable<I> for Binder<I, T>

fn visit_with<V: TypeVisitor<I>>(&self, visitor: &mut V) -> V::Result

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

impl<I, T> Copy for Binder<I, T>

where I: Interner, T: Copy,

impl<I, T> Eq for Binder<I, T>

where I: Interner, T: Eq,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.