Struct rustc_middle::ty::sty::Binder

pub struct Binder<T>(T);

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<TraitRef>). Note that when we instantiate, erase, or otherwise “discharge” these bound vars, we change the type from Binder<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.

Implementations

impl<'tcx> Binder<TraitRef<'tcx>>

pub fn print_only_trait_path(self) -> Binder<TraitRefPrintOnlyTraitPath<'tcx>>

impl<'tcx> Binder<ExistentialPredicate<'tcx>>

pub fn with_self_ty(
    &self,
    tcx: TyCtxt<'tcx>,
    self_ty: Ty<'tcx>
) -> Predicate<'tcx>

impl<'tcx> Binder<TraitRef<'tcx>>

pub fn self_ty(&self) -> Binder<Ty<'tcx>>

pub fn def_id(&self) -> DefId

pub fn to_poly_trait_predicate(&self) -> PolyTraitPredicate<'tcx>

impl<'tcx> Binder<ExistentialTraitRef<'tcx>>

pub fn def_id(&self) -> DefId

pub fn with_self_ty(
    &self,
    tcx: TyCtxt<'tcx>,
    self_ty: Ty<'tcx>
) -> PolyTraitRef<'tcx>

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<T> Binder<T>

pub fn dummy<'tcx>(value: T) -> Binder<T> where
    T: TypeFoldable<'tcx>, 

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(value: T) -> Binder<T>

Wraps value in a binder, binding higher-ranked vars (if any).

pub fn wrap_nonbinding<'tcx>(tcx: TyCtxt<'tcx>, value: T) -> Binder<T> where
    T: TypeFoldable<'tcx>, 

Wraps value in a binder without actually binding any currently unbound variables.

Note that this will shift all debrujin indices of escaping bound variables by 1 to avoid accidential captures.

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 replace_late_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 as_ref(&self) -> Binder<&T>

pub fn map_bound_ref<F, U>(&self, f: F) -> Binder<U> where
    F: FnOnce(&T) -> U, 

pub fn map_bound<F, U>(self, f: F) -> Binder<U> where
    F: FnOnce(T) -> U, 

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

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<'tcx>(self) -> Option<T> where
    T: TypeFoldable<'tcx>, 

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

pub fn fuse<U, F, R>(self, u: Binder<U>, f: F) -> Binder<R> where
    F: FnOnce(T, U) -> R, 

Given two things that have the same binder level, and an operation that wraps on their contents, executes the operation and then wraps its result.

f should consider bound regions at depth 1 to be free, and anything it produces with bound regions at depth 1 will be bound in the resulting return value.

pub fn split<U, V, F>(self, f: F) -> (Binder<U>, Binder<V>) where
    F: FnOnce(T) -> (U, V), 

Splits the contents into two things that share the same binder level as the original, returning two distinct binders.

f should consider bound regions at depth 1 to be free, and anything it produces with bound regions at depth 1 will be bound in the resulting return values.

impl<T> Binder<Option<T>>

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

impl<'tcx> Binder<GenSig<'tcx>>

pub fn resume_ty(&self) -> Binder<Ty<'tcx>>

pub fn yield_ty(&self) -> Binder<Ty<'tcx>>

pub fn return_ty(&self) -> Binder<Ty<'tcx>>

impl<'tcx> Binder<FnSig<'tcx>>

pub fn inputs(&self) -> Binder<&'tcx [Ty<'tcx>]>

pub fn input(&self, index: usize) -> Binder<Ty<'tcx>>

pub fn inputs_and_output(&self) -> Binder<&'tcx List<Ty<'tcx>>>

pub fn output(&self) -> Binder<Ty<'tcx>>

pub fn c_variadic(&self) -> bool

pub fn unsafety(&self) -> Unsafety

pub fn abi(&self) -> Abi

impl<'tcx> Binder<ExistentialProjection<'tcx>>

pub fn with_self_ty(
    &self,
    tcx: TyCtxt<'tcx>,
    self_ty: Ty<'tcx>
) -> PolyProjectionPredicate<'tcx>

pub fn item_def_id(&self) -> DefId

impl<'tcx> Binder<TraitPredicate<'tcx>>

pub fn def_id(self) -> DefId

pub fn self_ty(self) -> Binder<Ty<'tcx>>

impl<'tcx> Binder<ProjectionPredicate<'tcx>>

pub fn item_def_id(&self) -> DefId

Returns the DefId of the associated item being projected.

pub fn trait_def_id(&self, tcx: TyCtxt<'tcx>) -> DefId

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

pub fn projection_self_ty(&self) -> Binder<Ty<'tcx>>

pub fn required_poly_trait_ref(&self, tcx: TyCtxt<'tcx>) -> PolyTraitRef<'tcx>

Get the PolyTraitRef 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 ty(&self) -> Binder<Ty<'tcx>>

pub fn projection_def_id(&self) -> 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.

Trait Implementations

impl<'tcx> Borrow<Binder<PredicateKind<'tcx>>> for Interned<'tcx, PredicateInner<'tcx>>

fn borrow<'a>(&'a self) -> &'a Binder<PredicateKind<'tcx>>

Immutably borrows from an owned value.

impl<T: Clone> Clone for Binder<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Binder<T>

impl<T: Debug> Debug for Binder<T>

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

Formats the value using the given formatter.

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for Binder<PredicateKind<'tcx>>

fn decode(decoder: &mut D) -> Result<Binder<PredicateKind<'tcx>>, D::Error>

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for Binder<&'tcx List<Ty<'tcx>>>

fn decode(decoder: &mut D) -> Result<Self, D::Error>

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for Binder<FnSig<'tcx>>

fn decode(decoder: &mut D) -> Result<Self, D::Error>

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for Binder<ExistentialPredicate<'tcx>>

fn decode(decoder: &mut D) -> Result<Self, D::Error>

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for Binder<TraitRef<'tcx>>

fn decode(decoder: &mut D) -> Result<Self, D::Error>

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for Binder<Vec<GeneratorInteriorTypeCause<'tcx>>>

fn decode(decoder: &mut D) -> Result<Self, D::Error>

impl<'tcx> Display for Binder<ExistentialPredicate<'tcx>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<TraitRef<'tcx>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<TraitRefPrintOnlyTraitPath<'tcx>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<FnSig<'tcx>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<TraitPredicate<'tcx>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<SubtypePredicate<'tcx>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<ProjectionPredicate<'tcx>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<OutlivesPredicate<Ty<'tcx>, Region<'tcx>>>

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

Formats the value using the given formatter.

impl<'tcx> Display for Binder<OutlivesPredicate<Region<'tcx>, Region<'tcx>>>

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

Formats the value using the given formatter.

impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for Binder<PredicateKind<'tcx>>

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for Binder<&'tcx List<Ty<'tcx>>>

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for Binder<FnSig<'tcx>>

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for Binder<ExistentialPredicate<'tcx>>

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for Binder<TraitRef<'tcx>>

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for Binder<Vec<GeneratorInteriorTypeCause<'tcx>>>

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl<T: Eq> Eq for Binder<T>

impl<T: Hash> Hash for Binder<T>

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<'a, T> HashStable<StableHashingContext<'a>> for Binder<T> where
    T: HashStable<StableHashingContext<'a>>, 

fn hash_stable(
    &self,
    hcx: &mut StableHashingContext<'a>,
    hasher: &mut StableHasher
)

impl<'tcx, T: Lift<'tcx>> Lift<'tcx> for Binder<T>

type Lifted = Binder<T::Lifted>

fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted>

impl<T: Ord> Ord for Binder<T>

fn cmp(&self, other: &Binder<T>) -> 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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Binder<T>> for Binder<T>

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Binder<T>> for Binder<T>

fn partial_cmp(&self, other: &Binder<T>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<'tcx, T, P: PrettyPrinter<'tcx>> Print<'tcx, P> for Binder<T> where
    T: Print<'tcx, P, Output = P, Error = P::Error> + TypeFoldable<'tcx>, 

type Output = P

type Error = P::Error

fn print(&self, cx: P) -> Result<Self::Output, Self::Error>

impl<'tcx, T: Relate<'tcx>> Relate<'tcx> for Binder<T>

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

impl<T> StructuralEq for Binder<T>

impl<T> StructuralPartialEq for Binder<T>

impl<'tcx> ToPredicate<'tcx> for Binder<PredicateKind<'tcx>>

fn to_predicate(self, tcx: TyCtxt<'tcx>) -> Predicate<'tcx>

impl<'tcx, T: TypeFoldable<'tcx>> TypeFoldable<'tcx> for Binder<T>

fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

fn super_visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

fn visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this self has any regions that escape binder (and hence are not bound by it).

fn has_escaping_bound_vars(&self) -> bool

fn has_type_flags(&self, flags: TypeFlags) -> bool

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn has_param_types_or_consts(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_infer_types_or_consts(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.