Struct rustc_type_ir::Binder

source ·
pub struct Binder<I: Interner, T> {
    value: T,
    bound_vars: I::BoundVarKinds,
}
Expand description

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§

source§

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

source

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.

source

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

source§

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

source

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
source

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

source

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

source

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

source

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

source

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

source

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

source

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.

source

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

source§

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

source

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

source§

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

source

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

source§

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

source

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

source

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

source§

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

source

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

source

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

source

pub fn polarity(self) -> PredicatePolarity

source§

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

source

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

source§

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

source

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

source

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.

source§

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

source

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

source

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

source§

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

source

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

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

source

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.

source

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

source

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.

source§

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

source

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

source

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

source

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

source

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

source

pub fn c_variadic(self) -> bool

source

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

source

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

source

pub fn is_fn_trait_compatible(&self) -> bool

source

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

source§

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

source

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

source

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

source

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

source

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

source

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

Trait Implementations§

source§

impl<I, T> Clone for Binder<I, T>
where I: Interner, T: Clone,

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<I, T> Debug for Binder<I, T>
where I: Interner, T: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<I, T> Display for Binder<I, T>
where I: IrPrint<Binder<I, T>> + Interner,

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<I, T> Hash for Binder<I, T>
where I: Interner, T: Hash,

source§

fn hash<__H: Hasher>(&self, __state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

source§

impl<I: Interner, U: Interner, T> Lift<U> for Binder<I, T>
where T: Lift<U>, I::BoundVarKinds: Lift<U, Lifted = U::BoundVarKinds>,

source§

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

source§

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

source§

impl<I, T> PartialEq for Binder<I, T>
where I: Interner, T: PartialEq,

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

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

source§

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

source§

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

source§

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). Read more
source§

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.
source§

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

source§

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

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.
source§

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

source§

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

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

source§

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). Read more
source§

impl<I, T> Copy for Binder<I, T>
where I: Interner, T: Copy,

source§

impl<I, T> Eq for Binder<I, T>
where I: Interner, T: Eq,

Auto Trait Implementations§

§

impl<I, T> Freeze for Binder<I, T>
where T: Freeze, <I as Interner>::BoundVarKinds: Freeze,

§

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

§

impl<I, T> Send for Binder<I, T>
where T: Send, <I as Interner>::BoundVarKinds: Send,

§

impl<I, T> Sync for Binder<I, T>
where T: Sync, <I as Interner>::BoundVarKinds: Sync,

§

impl<I, T> Unpin for Binder<I, T>
where T: Unpin, <I as Interner>::BoundVarKinds: Unpin,

§

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

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T, R> CollectAndApply<T, R> for T

source§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

source§

type Output = R

source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<I, T> TypeVisitableExt<I> for T
where I: Interner, T: TypeVisitable<I>,

source§

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

source§

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.
source§

fn error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>

source§

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

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

fn has_escaping_bound_vars(&self) -> bool

Return true if this type has regions that are not a part of the type. For example, for<'a> fn(&'a i32) return false, while fn(&'a i32) would return true. The latter can occur when traversing through the former. Read more
source§

fn has_aliases(&self) -> bool

source§

fn has_opaque_types(&self) -> bool

source§

fn has_coroutines(&self) -> bool

source§

fn references_error(&self) -> bool

source§

fn has_non_region_param(&self) -> bool

source§

fn has_infer_regions(&self) -> bool

source§

fn has_infer_types(&self) -> bool

source§

fn has_non_region_infer(&self) -> bool

source§

fn has_infer(&self) -> bool

source§

fn has_placeholders(&self) -> bool

source§

fn has_non_region_placeholders(&self) -> bool

source§

fn has_param(&self) -> bool

source§

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.
source§

fn has_erased_regions(&self) -> bool

source§

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.
source§

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.
source§

fn has_bound_regions(&self) -> bool

True if there are any late-bound regions
source§

fn has_non_region_bound_vars(&self) -> bool

True if there are any late-bound non-region variables
source§

fn has_bound_vars(&self) -> bool

True if there are any bound variables
source§

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.
source§

impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

source§

fn upcast(self, interner: I) -> U

source§

impl<I, T> UpcastFrom<I, T> for T

source§

fn upcast_from(from: T, _tcx: I) -> T

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,

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.