## BoundVarIndexKind

# Enum BoundVarIndexKind

    pub enum BoundVarIndexKind {
        Bound(DebruijnIndex),
        Canonical,
    }

Expand description

Okay, we do something fun for `Bound` types/regions/consts: Specifically, we distinguish between canonically bound things and `for<>` bound things. And, really, it comes down to caching during canonicalization and instantiation.

To understand why we do this, imagine we have a type `(T, for<> fn(T))`. If we just tracked canonically bound types with a `DebruijnIndex` (as we used to), then the canonicalized type would be something like `for<0> (^0.0, for<> fn(^1.0))` and so we can’t cache `T -> ^0.0`, we have to also factor in binder level. (Of course, we don’t cache that exactly, but rather the entire enclosing type, but the point stands.)

Of course, this is okay because we don’t ever nest canonicalization, so `BoundVarIndexKind::Canonical` is unambiguous. We, alternatively, could have some sentinel `DebruijinIndex`, but that just seems too scary.

This doesn’t seem to have a huge perf swing either way, but in the next solver, canonicalization is hot and there are some pathological cases where this is needed (`post-mono-higher-ranked-hang`).

## Variants§

§

### Bound(DebruijnIndex)

§

### Canonical

## Trait Implementations§

§

### impl Clone for BoundVarIndexKind

§

#### fn clone(&self) -> BoundVarIndexKind

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from `source`. Read more
§

### impl Debug for BoundVarIndexKind

§

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

Formats the value using the given formatter. Read more
§

### impl<__D> Decodable<__D> for BoundVarIndexKind
where __D: Decoder,

§

#### fn decode(__decoder: &mut __D) -> BoundVarIndexKind

§

### impl<__E> Encodable<__E> for BoundVarIndexKind
where __E: Encoder,

§

#### fn encode(&self, __encoder: &mut __E)

§

### impl Hash for BoundVarIndexKind

§

#### fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

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

#### 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
§

### impl<__CTX> HashStable<__CTX> for BoundVarIndexKind

§

#### fn hash_stable( &self, __hcx: &mut __CTX, __hasher: &mut StableHasher<SipHasher128>, )

§

### impl PartialEq for BoundVarIndexKind

§

#### fn eq(&self, other: &BoundVarIndexKind) -> bool

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

#### 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> TypeFoldable<I> for BoundVarIndexKind
where I: Interner,

§

#### fn try_fold_with<__F>( self, __folder: &mut __F, ) -> Result<BoundVarIndexKind, <__F as FallibleTypeFolder<I>>::Error>
where __F: FallibleTypeFolder<I>,

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

#### fn fold_with<__F>(self, __folder: &mut __F) -> BoundVarIndexKind
where __F: TypeFolder<I>,

The entry point for folding. To fold a value `t` with a folder `f` call: `t.fold_with(f)`. Read more
§

### impl<I> TypeVisitable<I> for BoundVarIndexKind
where I: Interner,

§

#### fn visit_with<__V>( &self, __visitor: &mut __V, ) -> <__V as TypeVisitor<I>>::Result
where __V: TypeVisitor<I>,

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

### impl Copy for BoundVarIndexKind

§

### impl Eq for BoundVarIndexKind

§

### impl StructuralPartialEq for BoundVarIndexKind

## Auto Trait Implementations§

§

### impl DynSend for BoundVarIndexKind

§

### impl DynSync for BoundVarIndexKind

§

### impl Freeze for BoundVarIndexKind

§

### impl RefUnwindSafe for BoundVarIndexKind

§

### impl Send for BoundVarIndexKind

§

### impl Sync for BoundVarIndexKind

§

### impl Unpin for BoundVarIndexKind

§

### impl UnwindSafe for BoundVarIndexKind

## Blanket Implementations§

§

### impl<T> Aligned for T

§

#### const ALIGN: Alignment

Alignment of `Self`.
§

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

§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
§

### impl<T> AnyEq for T
where T: Any + PartialEq,

§

#### fn equals(&self, other: &(dyn Any + 'static)) -> bool

§

#### fn as_any(&self) -> &(dyn Any + 'static)

§

### impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where T: Copy,

§

#### fn allocate_on(self, arena: &'tcx Arena<'tcx>) -> &'tcx mut T

§

#### fn allocate_from_iter( arena: &'tcx Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'tcx mut [T]

§

### impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where T: Copy,

§

#### fn allocate_on(self, arena: &'tcx Arena<'tcx>) -> &'tcx mut T

§

#### fn allocate_from_iter( arena: &'tcx Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'tcx mut [T]

§

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

§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

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

§

#### 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<_>>())`.

§

#### type Output = R

§

### impl<Tcx, T> DepNodeParams<Tcx> for T
where Tcx: DepContext, T: for<'a> HashStable<StableHashingContext<'a>> + Debug,

§

#### default fn fingerprint_style() -> FingerprintStyle

§

#### default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint

This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous).
§

#### default fn to_debug_str(&self, tcx: Tcx) -> String

§

#### default fn recover(_: Tcx, _: &DepNode) -> Option<T>

This method tries to recover the query key from the given `DepNode`, something which is needed when forcing `DepNode`s during red-green evaluation. The query system will only call this method if `fingerprint_style()` is not `FingerprintStyle::Opaque`. It is always valid to return `None` here, in which case incremental compilation will treat the query as having changed instead of forcing it.
§

### impl<T> DynClone for T
where T: Clone,

§

#### fn __clone_box(&self, _: Private) -> *mut ()

§

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

§

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

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

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

§

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

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

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

§

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

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

### impl<T> From<T> for T

§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

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

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

#### fn in_current_span(self) -> Instrumented<Self>

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

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

§

#### fn into(self) -> U

Calls `U::from(self)`.

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

§

### impl<T> IntoEither for T

§

#### 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
§

#### 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
§

### impl<P> IntoQueryParam<P> for P

§

#### fn into_query_param(self) -> P

§

### impl<'tcx, T> IsSuggestable<'tcx> for T
where T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,

§

#### fn is_suggestable(self, tcx: TyCtxt<'tcx>, infer_suggestable: bool) -> bool

Whether this makes sense to suggest in a diagnostic. Read more
§

#### fn make_suggestable( self, tcx: TyCtxt<'tcx>, infer_suggestable: bool, placeholder: Option<Ty<'tcx>>, ) -> Option<T>

§

### impl<T> MaybeResult<T> for T

§

#### type Error = !

§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

§

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
§

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

§

#### type Owned = T

The resulting type after obtaining ownership.
§

#### fn to_owned(&self) -> T

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

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

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

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

§

#### type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
§

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

§

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

§

#### 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 error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>

§

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

#### 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
§

#### fn has_aliases(&self) -> bool

§

#### fn has_opaque_types(&self) -> bool

§

#### fn has_coroutines(&self) -> bool

§

#### fn references_error(&self) -> bool

§

#### fn has_non_region_param(&self) -> bool

§

#### fn has_infer_regions(&self) -> bool

§

#### fn has_infer_types(&self) -> bool

§

#### fn has_non_region_infer(&self) -> bool

§

#### fn has_infer(&self) -> bool

§

#### fn has_placeholders(&self) -> bool

§

#### fn has_non_region_placeholders(&self) -> bool

§

#### fn has_param(&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_bound_regions(&self) -> bool

True if there are any late-bound regions
§

#### fn has_non_region_bound_vars(&self) -> bool

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

#### fn has_bound_vars(&self) -> bool

True if there are any bound variables
§

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

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

§

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

§

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

§

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

§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

§

#### default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T

§

### impl<T> WithSubscriber for T

§

#### 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
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

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

### impl<T> ErasedDestructor for T
where T: 'static,

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes

Size for each variant:

- `Bound`: 4 bytes
- `Canonical`: 0 bytes