Struct rustc_type_ir::canonical::Canonical
source · pub struct Canonical<I: Interner, V> {
pub value: V,
pub max_universe: UniverseIndex,
pub defining_opaque_types: I::DefiningOpaqueTypes,
pub variables: I::CanonicalVars,
}
Expand description
A “canonicalized” type V
is one where all free inference
variables have been rewritten to “canonical vars”. These are
numbered starting from 0 in order of first appearance.
Fields§
§value: V
§max_universe: UniverseIndex
§defining_opaque_types: I::DefiningOpaqueTypes
§variables: I::CanonicalVars
Implementations§
source§impl<I: Interner, V> Canonical<I, V>
impl<I: Interner, V> Canonical<I, V>
sourcepub fn unchecked_map<W>(self, map_op: impl FnOnce(V) -> W) -> Canonical<I, W>
pub fn unchecked_map<W>(self, map_op: impl FnOnce(V) -> W) -> Canonical<I, W>
Allows you to map the value
of a canonical while keeping the
same set of bound variables.
WARNING: This function is very easy to mis-use, hence the
name! In particular, the new value W
must use all the
same type/region variables in precisely the same order
as the original! (The ordering is defined by the
TypeFoldable
implementation of the type in question.)
An example of a correct use of this:
let a: Canonical<I, T> = ...;
let b: Canonical<I, (T,)> = a.unchecked_map(|v| (v, ));
An example of an incorrect use of this:
let a: Canonical<I, T> = ...;
let ty: Ty<I> = ...;
let b: Canonical<I, (T, Ty<I>)> = a.unchecked_map(|v| (v, ty));
sourcepub fn unchecked_rebind<W>(self, value: W) -> Canonical<I, W>
pub fn unchecked_rebind<W>(self, value: W) -> Canonical<I, W>
Allows you to map the value
of a canonical while keeping the same set of
bound variables.
WARNING: This function is very easy to mis-use, hence the name! See the comment of Canonical::unchecked_map for more details.
Trait Implementations§
source§impl<I: Interner, V, __CTX> HashStable<__CTX> for Canonical<I, V>where
V: HashStable<__CTX>,
I::DefiningOpaqueTypes: HashStable<__CTX>,
I::CanonicalVars: HashStable<__CTX>,
impl<I: Interner, V, __CTX> HashStable<__CTX> for Canonical<I, V>where
V: HashStable<__CTX>,
I::DefiningOpaqueTypes: HashStable<__CTX>,
I::CanonicalVars: HashStable<__CTX>,
fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)
source§impl<I, V> TypeFoldable<I> for Canonical<I, V>where
I: Interner,
V: TypeFoldable<I>,
I::DefiningOpaqueTypes: TypeFoldable<I>,
I::CanonicalVars: TypeFoldable<I>,
impl<I, V> TypeFoldable<I> for Canonical<I, V>where
I: Interner,
V: TypeFoldable<I>,
I::DefiningOpaqueTypes: TypeFoldable<I>,
I::CanonicalVars: TypeFoldable<I>,
source§fn try_fold_with<__F: FallibleTypeFolder<I>>(
self,
__folder: &mut __F,
) -> Result<Self, __F::Error>
fn try_fold_with<__F: FallibleTypeFolder<I>>( self, __folder: &mut __F, ) -> Result<Self, __F::Error>
source§fn fold_with<F: TypeFolder<I>>(self, folder: &mut F) -> Self
fn fold_with<F: TypeFolder<I>>(self, folder: &mut F) -> Self
try_fold_with
for use with infallible
folders. Do not override this method, to ensure coherence with
try_fold_with
.source§impl<I, V> TypeVisitable<I> for Canonical<I, V>where
I: Interner,
V: TypeVisitable<I>,
I::DefiningOpaqueTypes: TypeVisitable<I>,
I::CanonicalVars: TypeVisitable<I>,
impl<I, V> TypeVisitable<I> for Canonical<I, V>where
I: Interner,
V: TypeVisitable<I>,
I::DefiningOpaqueTypes: TypeVisitable<I>,
I::CanonicalVars: TypeVisitable<I>,
source§fn visit_with<__V: TypeVisitor<I>>(&self, __visitor: &mut __V) -> __V::Result
fn visit_with<__V: TypeVisitor<I>>(&self, __visitor: &mut __V) -> __V::Result
impl<I, V> Copy for Canonical<I, V>
impl<I, V> Eq for Canonical<I, V>
Auto Trait Implementations§
impl<I, V> Freeze for Canonical<I, V>where
V: Freeze,
<I as Interner>::DefiningOpaqueTypes: Freeze,
<I as Interner>::CanonicalVars: Freeze,
impl<I, V> RefUnwindSafe for Canonical<I, V>where
V: RefUnwindSafe,
<I as Interner>::DefiningOpaqueTypes: RefUnwindSafe,
<I as Interner>::CanonicalVars: RefUnwindSafe,
impl<I, V> Send for Canonical<I, V>
impl<I, V> Sync for Canonical<I, V>
impl<I, V> Unpin for Canonical<I, V>
impl<I, V> UnwindSafe for Canonical<I, V>where
V: UnwindSafe,
<I as Interner>::DefiningOpaqueTypes: UnwindSafe,
<I as Interner>::CanonicalVars: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
fn has_type_flags(&self, flags: TypeFlags) -> bool
source§fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
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>
source§fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
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
fn has_escaping_bound_vars(&self) -> bool
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 morefn 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
source§fn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
source§fn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
source§fn is_global(&self) -> bool
fn is_global(&self) -> bool
source§fn has_bound_regions(&self) -> bool
fn has_bound_regions(&self) -> bool
source§fn has_non_region_bound_vars(&self) -> bool
fn has_non_region_bound_vars(&self) -> bool
source§fn has_bound_vars(&self) -> bool
fn has_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.source§impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
source§impl<I, T> UpcastFrom<I, T> for T
impl<I, T> UpcastFrom<I, T> for T
fn upcast_from(from: T, _tcx: I) -> T
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
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.