Struct rustc_middle::ty::sty::Binder[][src]

pub struct Binder<'tcx, T>(T, &'tcx List<BoundVariableKind>);
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<'tcx, TraitRef>). Note that when we instantiate, erase, or otherwise “discharge” these bound vars, we change the type from Binder<'tcx, 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<'tcx, TraitRef<'tcx>>[src]

pub fn print_only_trait_path(
    self
) -> Binder<'tcx, TraitRefPrintOnlyTraitPath<'tcx>>
[src]

impl<'tcx> Binder<'tcx, ExistentialPredicate<'tcx>>[src]

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

impl<'tcx> Binder<'tcx, TraitRef<'tcx>>[src]

pub fn self_ty(&self) -> Binder<'tcx, Ty<'tcx>>[src]

pub fn def_id(&self) -> DefId[src]

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

impl<'tcx> Binder<'tcx, ExistentialTraitRef<'tcx>>[src]

pub fn def_id(&self) -> DefId[src]

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

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<'tcx, T> Binder<'tcx, T> where
    T: TypeFoldable<'tcx>, 
[src]

pub fn dummy(value: T) -> Binder<'tcx, T>[src]

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, tcx: TyCtxt<'tcx>) -> Binder<'tcx, T>[src]

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

pub fn bind_with_vars(
    value: T,
    vars: &'tcx List<BoundVariableKind>
) -> Binder<'tcx, T>
[src]

impl<'tcx, T> Binder<'tcx, T>[src]

pub fn skip_binder(self) -> T[src]

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 bound_vars(&self) -> &'tcx List<BoundVariableKind>[src]

pub fn as_ref(&self) -> Binder<'tcx, &T>[src]

pub fn map_bound_ref_unchecked<F, U>(&self, f: F) -> Binder<'tcx, U> where
    F: FnOnce(&T) -> U, 
[src]

pub fn map_bound_ref<F, U: TypeFoldable<'tcx>>(&self, f: F) -> Binder<'tcx, U> where
    F: FnOnce(&T) -> U, 
[src]

pub fn map_bound<F, U: TypeFoldable<'tcx>>(self, f: F) -> Binder<'tcx, U> where
    F: FnOnce(T) -> U, 
[src]

pub fn rebind<U>(&self, value: U) -> Binder<'tcx, U> where
    U: TypeFoldable<'tcx>, 
[src]

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: TypeFoldable<'tcx>, 
[src]

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 split<U, V, F>(self, f: F) -> (Binder<'tcx, U>, Binder<'tcx, V>) where
    F: FnOnce(T) -> (U, V)
[src]

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<'tcx, T> Binder<'tcx, Option<T>>[src]

pub fn transpose(self) -> Option<Binder<'tcx, T>>[src]

impl<'tcx> Binder<'tcx, FnSig<'tcx>>[src]

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

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

pub fn inputs_and_output(&self) -> Binder<'tcx, &'tcx List<Ty<'tcx>>>[src]

pub fn output(&self) -> Binder<'tcx, Ty<'tcx>>[src]

pub fn c_variadic(&self) -> bool[src]

pub fn unsafety(&self) -> Unsafety[src]

pub fn abi(&self) -> Abi[src]

impl<'tcx> Binder<'tcx, ExistentialProjection<'tcx>>[src]

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

pub fn item_def_id(&self) -> DefId[src]

impl<'tcx> Binder<'tcx, TraitPredicate<'tcx>>[src]

pub fn def_id(self) -> DefId[src]

pub fn self_ty(self) -> Binder<'tcx, Ty<'tcx>>[src]

impl<'tcx> Binder<'tcx, ProjectionPredicate<'tcx>>[src]

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

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

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

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<'tcx, Ty<'tcx>>[src]

pub fn projection_def_id(&self) -> DefId[src]

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<'tcx, PredicateKind<'tcx>>> for Interned<'tcx, PredicateInner<'tcx>>[src]

fn borrow<'a>(&'a self) -> &'a Binder<'tcx, PredicateKind<'tcx>>[src]

Immutably borrows from an owned value. Read more

impl<'tcx, T: Clone> Clone for Binder<'tcx, T>[src]

fn clone(&self) -> Binder<'tcx, T>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'tcx, T: Debug> Debug for Binder<'tcx, T>[src]

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

Formats the value using the given formatter. Read more

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

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

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

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

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

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

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

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

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

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

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

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

impl<'tcx> Display for Binder<'tcx, ExistentialPredicate<'tcx>>[src]

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

Formats the value using the given formatter. Read more

impl<'tcx> Display for Binder<'tcx, TraitRef<'tcx>>[src]

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

Formats the value using the given formatter. Read more

impl<'tcx> Display for Binder<'tcx, TraitRefPrintOnlyTraitPath<'tcx>>[src]

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

Formats the value using the given formatter. Read more

impl<'tcx> Display for Binder<'tcx, FnSig<'tcx>>[src]

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

Formats the value using the given formatter. Read more

impl<'tcx> Display for Binder<'tcx, TraitPredicate<'tcx>>[src]

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

Formats the value using the given formatter. Read more

impl<'tcx> Display for Binder<'tcx, SubtypePredicate<'tcx>>[src]

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

Formats the value using the given formatter. Read more

impl<'tcx> Display for Binder<'tcx, ProjectionPredicate<'tcx>>[src]

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

impl<'tcx> Display for Binder<'tcx, OutlivesPredicate<Region<'tcx>, Region<'tcx>>>[src]

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

Formats the value using the given formatter. Read more

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

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

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

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

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

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

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

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

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

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

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

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

impl<'tcx, T: Hash> Hash for Binder<'tcx, T>[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

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

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

impl<'a, 'tcx, T> HashStable<StableHashingContext<'a>> for Binder<'tcx, T> where
    T: HashStable<StableHashingContext<'a>>, 
[src]

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

impl<'a, 'tcx, T: Lift<'tcx>> Lift<'tcx> for Binder<'a, T> where
    <T as Lift<'tcx>>::Lifted: TypeFoldable<'tcx>, 
[src]

type Lifted = Binder<'tcx, T::Lifted>

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

impl<'tcx, T: Ord> Ord for Binder<'tcx, T>[src]

fn cmp(&self, other: &Binder<'tcx, T>) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl<'tcx, T: PartialEq> PartialEq<Binder<'tcx, T>> for Binder<'tcx, T>[src]

fn eq(&self, other: &Binder<'tcx, T>) -> bool[src]

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

fn ne(&self, other: &Binder<'tcx, T>) -> bool[src]

This method tests for !=.

impl<'tcx, T: PartialOrd> PartialOrd<Binder<'tcx, T>> for Binder<'tcx, T>[src]

fn partial_cmp(&self, other: &Binder<'tcx, T>) -> Option<Ordering>[src]

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

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

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

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

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

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

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<'tcx, T, P: PrettyPrinter<'tcx>> Print<'tcx, P> for Binder<'tcx, T> where
    T: Print<'tcx, P, Output = P, Error = P::Error> + TypeFoldable<'tcx>, 
[src]

type Output = P

type Error = P::Error

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

impl<'tcx, T: Relate<'tcx>> Relate<'tcx> for Binder<'tcx, T>[src]

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

impl<'tcx> ToPredicate<'tcx> for Binder<'tcx, PredicateKind<'tcx>>[src]

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

impl<'tcx, T: TypeFoldable<'tcx>> TypeFoldable<'tcx> for Binder<'tcx, T>[src]

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

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

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

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

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

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. Read more

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

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

fn has_escaping_bound_vars(&self) -> bool[src]

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

fn has_projections(&self) -> bool[src]

fn has_opaque_types(&self) -> bool[src]

fn references_error(&self) -> bool[src]

fn has_param_types_or_consts(&self) -> bool[src]

fn has_infer_regions(&self) -> bool[src]

fn has_infer_types(&self) -> bool[src]

fn has_infer_types_or_consts(&self) -> bool[src]

fn needs_infer(&self) -> bool[src]

fn has_placeholders(&self) -> bool[src]

fn needs_subst(&self) -> bool[src]

fn has_free_regions(&self) -> bool[src]

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

fn has_erased_regions(&self) -> bool[src]

fn has_erasable_regions(&self) -> bool[src]

True if there are any un-erased free regions.

fn is_global(&self) -> bool[src]

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. Read more

fn has_late_bound_regions(&self) -> bool[src]

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool[src]

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. Read more

impl<'tcx, T: Copy> Copy for Binder<'tcx, T>[src]

impl<'tcx, T: Eq> Eq for Binder<'tcx, T>[src]

impl<'tcx, T> StructuralEq for Binder<'tcx, T>[src]

impl<'tcx, T> StructuralPartialEq for Binder<'tcx, T>[src]

Auto Trait Implementations

impl<'tcx, T> !RefUnwindSafe for Binder<'tcx, T>

impl<'tcx, T> Send for Binder<'tcx, T> where
    T: Send

impl<'tcx, T> Sync for Binder<'tcx, T> where
    T: Sync

impl<'tcx, T> Unpin for Binder<'tcx, T> where
    T: Unpin

impl<'tcx, T> !UnwindSafe for Binder<'tcx, T>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<'tcx, T> ArenaAllocatable<'tcx, ()> for T where
    T: Copy
[src]

pub fn allocate_on(Self, &'a Arena<'tcx>) -> &'a mut T[src]

pub fn allocate_from_iter(
    &'a Arena<'tcx>,
    impl IntoIterator<Item = T>
) -> &'a mut [T]

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> MaybeResult<T> for T[src]

type Error = !

pub fn from(Result<T, <T as MaybeResult<T>>::Error>) -> T[src]

pub fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>[src]

impl<'tcx, T> Subst<'tcx> for T where
    T: TypeFoldable<'tcx>, 
[src]

pub fn subst_spanned(Self, TyCtxt<'tcx>, &[GenericArg<'tcx>], Option<Span>) -> T[src]

fn subst(self, tcx: TyCtxt<'tcx>, substs: &[GenericArg<'tcx>]) -> Self[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T> ToString for T where
    T: Display + ?Sized
[src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithConstness for T[src]

fn with_constness(self, constness: Constness) -> ConstnessAnd<Self>[src]

fn with_const(self) -> ConstnessAnd<Self>[src]

fn without_const(self) -> ConstnessAnd<Self>[src]

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

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.