Unnormalized in rustc_type_ir - Rust
Description: A wrapper for values that need normalization.

Skip to main content

## Unnormalized

# Struct Unnormalized

Source

    pub struct Unnormalized<I: Interner, T> {
        value: T,
        _tcx: PhantomData<fn() -> I>,
    }

Expand description

A wrapper for values that need normalization.

FIXME(#155345): This is very WIP. The plan is to replace the `skip_norm_wip` spread throughout the codebase with proper normalization. This is the first step toward switching to eager normalization with the next solver. See the normalization refactor plan here.

We’re in a weird intermediate state as the change is too big to land in a single PR. While this work is in progress, just use `Unnormalized::new_wip` and `Unnormalized::skip_norm_wip` as needed.

The interner type parameter exists to constraint generic for certain impl, e.g., `Unnormalized<I, I::Clause>`.

## Fields§

§`value: T`§`_tcx: PhantomData<fn() -> I>`

## Implementations§

Source§

### impl<I: Interner, T> Unnormalized<I, T>

Source

#### pub fn new(value: T) -> Unnormalized<I, T>

Should only be used in limited situations where you produce an potentially unnormalized value, like in (Early)Binder/GenericPredicates instantiation.

Source

#### pub fn dummy(value: T) -> Unnormalized<I, T>

Should be used in case we have an already normalized input as an argument to a function that also expects unnormalized inputs, e.g. getting the tail of a type is normalized for tuples, but unnormalized for ADTs.

Source

#### pub fn new_wip(value: T) -> Unnormalized<I, T>

FIXME: This is going to be eventually removed once we migrate the relevant APIs to return `Unnormalized`.

Source

#### pub fn skip_normalization(self) -> T

Intentionally skip normalization. You probably should perform normalization in most cases.

Source

#### pub fn skip_norm_wip(self) -> T

FIXME: This is going to be eventually removed. If you meet this in codebase, try using one of the normalization routines to consume the `Unnormalized` wrapper. Or use `skip_normalization` when normalization is really unnecessary.

Source

#### pub fn map<F, U>(self, f: F) -> Unnormalized<I, U>
where F: FnOnce(T) -> U,

Source

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

Source

#### pub fn map_ref<U, F>(&self, f: F) -> Unnormalized<I, U>
where F: FnOnce(&T) -> U,

Source§

### impl<I: Interner, T, U> Unnormalized<I, (T, U)>

Source

#### pub fn unzip(self) -> (Unnormalized<I, T>, Unnormalized<I, U>)

Source§

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

Source

#### pub fn skip_binder(self) -> T

Source§

### impl<I: Interner> Unnormalized<I, I::Clause>

Source

#### pub fn as_trait_clause( self, ) -> Option<Unnormalized<I, Binder<I, TraitPredicate<I>>>>

Source

#### pub fn kind(self) -> Unnormalized<I, Binder<I, ClauseKind<I>>>

Source§

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

Source

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

Source

#### pub fn def_id(self) -> I::TraitId

Source

#### pub fn polarity(self) -> PredicatePolarity

Source§

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

Source

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

Source

#### pub fn def_id(&self) -> I::TraitId

Source

#### pub fn to_host_effect_clause( self, cx: I, constness: BoundConstness, ) -> Unnormalized<I, I::Clause>

## Trait Implementations§

Source§

### impl<I: Interner, T> Clone for Unnormalized<I, T>
where T: Clone,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

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

### impl<I: Interner, T> Copy for Unnormalized<I, T>
where T: Copy,

Source§

### impl<I: Interner, T> Debug for Unnormalized<I, T>
where T: Debug,

Source§

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

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

### impl<I: Interner, T> PartialEq for Unnormalized<I, T>
where 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 (const: unstable) · 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> PartialOrd for Unnormalized<I, T>
where T: PartialOrd,

Source§

#### fn partial_cmp(&self, __other: &Self) -> Option<Ordering>

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
Source§

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

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

## Auto Trait Implementations§

§

### impl<I, T> DynSend for Unnormalized<I, T>
where T: DynSend,

§

### impl<I, T> DynSync for Unnormalized<I, T>
where T: DynSync,

§

### impl<I, T> Freeze for Unnormalized<I, T>
where T: Freeze,

§

### impl<I, T> RefUnwindSafe for Unnormalized<I, T>
where T: RefUnwindSafe,

§

### impl<I, T> Send for Unnormalized<I, T>
where T: Send,

§

### impl<I, T> Sync for Unnormalized<I, T>
where T: Sync,

§

### impl<I, T> Unpin for Unnormalized<I, T>
where T: Unpin,

§

### impl<I, T> UnsafeUnpin for Unnormalized<I, T>
where T: UnsafeUnpin,

§

### impl<I, T> UnwindSafe for Unnormalized<I, T>
where T: UnwindSafe,

## Blanket Implementations§

§

### impl<T> Aligned for T

§

#### 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> AnyEq for T
where T: Any + PartialEq,

Source§

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

Source§

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

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. 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<T> ErasedDestructor for T
where T: 'static,

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> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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

Drops the object pointed to by the given pointer. 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, 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 non_region_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

Returns `true` if this type has regions that are not a part of the type. For example, given a `for<'a> fn(&'a i32)` this function returns `false`, while given a `fn(&'a i32)` it returns `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_regions(&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§

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

True if a type or const error is reachable
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

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

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

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