Struct rustc_middle::ty::ParamEnv

pub struct ParamEnv<'tcx> {
    packed: CopyTaggedPtr<&'tcx List<Predicate<'tcx>>, ParamTag, true>,
}

When type checking, we use the ParamEnv to track details about the set of where-clauses that are in scope at this particular point.

Fields

packed: CopyTaggedPtr<&'tcx List<Predicate<'tcx>>, ParamTag, true>

This packs both caller bounds and the reveal enum into one pointer.

Caller bounds are Obligations that the caller must satisfy. This is basically the set of bounds on the in-scope type parameters, translated into Obligations, and elaborated and normalized.

Use the caller_bounds() method to access.

Typically, this is Reveal::UserFacing, but during codegen we want Reveal::All.

Note: This is packed, use the reveal() method to access it.

Implementations

impl<'tcx> ParamEnv<'tcx>

pub fn empty() -> Self

Construct a trait environment suitable for contexts where there are no where-clauses in scope. Hidden types (like impl Trait) are left hidden, so this is suitable for ordinary type-checking.

pub fn caller_bounds(self) -> &'tcx List<Predicate<'tcx>>

pub fn reveal(self) -> Reveal

pub fn constness(self) -> Constness

pub fn is_const(self) -> bool

pub fn reveal_all() -> Self

Construct a trait environment with no where-clauses in scope where the values of all impl Trait and other hidden types are revealed. This is suitable for monomorphized, post-typeck environments like codegen or doing optimizations.

N.B., if you want to have predicates in scope, use ParamEnv::new, or invoke param_env.with_reveal_all().

pub fn new(
    caller_bounds: &'tcx List<Predicate<'tcx>>,
    reveal: Reveal,
    constness: Constness
) -> Self

Construct a trait environment with the given set of predicates.

pub fn with_user_facing(self) -> Self

pub fn with_constness(self, constness: Constness) -> Self

pub fn with_const(self) -> Self

pub fn without_const(self) -> Self

pub fn remap_constness_with(&mut self, constness: BoundConstness)

pub fn with_reveal_all_normalized(self, tcx: TyCtxt<'tcx>) -> Self

Returns a new parameter environment with the same clauses, but which “reveals” the true results of projections in all cases (even for associated types that are specializable). This is the desired behavior during codegen and certain other special contexts; normally though we want to use Reveal::UserFacing, which is the default. All opaque types in the caller_bounds of the ParamEnv will be normalized to their underlying types. See PR #65989 and issue #65918 for more details

pub fn without_caller_bounds(self) -> Self

Returns this same environment but with no caller bounds.

pub fn and<T: TypeVisitable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T>

Creates a suitable environment in which to perform trait queries on the given value. When type-checking, this is simply the pair of the environment plus value. But when reveal is set to All, then if value does not reference any type parameters, we will pair it with the empty environment. This improves caching and is generally invisible.

N.B., we preserve the environment when type-checking because it is possible for the user to have wacky where-clauses like where Box<u32>: Copy, which are clearly never satisfiable. We generally want to behave as if they were true, although the surrounding function is never reachable.

Trait Implementations

impl<'tcx> Clone for ParamEnv<'tcx>

fn clone(&self) -> ParamEnv<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for ParamEnv<'tcx>

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

Formats the value using the given formatter.

impl<'tcx> Hash for ParamEnv<'tcx>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for ParamEnv<'tcx>

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

impl<'tcx> Key for ParamEnv<'tcx>

fn query_crate_is_local(&self) -> bool

Given an instance of this key, what crate is it referring to? This is used to find the provider.

fn default_span(&self, _: TyCtxt<'_>) -> Span

In the event that a cycle occurs, if no explicit span has been given for a query with key self, what span should we use?

type CacheSelector = DefaultCacheSelector<Self>

fn key_as_def_id(&self) -> Option<DefId>

If the key is a DefId or DefId–equivalent, return that DefId. Otherwise, return None.

fn ty_adt_id(&self) -> Option<DefId>

impl<'a, 'tcx> Lift<'tcx> for ParamEnv<'a>

type Lifted = ParamEnv<'tcx>

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

impl<'tcx> PartialEq<ParamEnv<'tcx>> for ParamEnv<'tcx>

fn eq(&self, other: &ParamEnv<'tcx>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tcx> TypeFoldable<'tcx> for ParamEnv<'tcx>

fn try_fold_with<F: FallibleTypeFolder<'tcx>>(
    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).

fn fold_with<F: TypeFolder<'tcx>>(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.

impl<'tcx> TypeVisitable<'tcx> for ParamEnv<'tcx>

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

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

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

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

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn error_reported(&self) -> Result<(), ErrorGuaranteed>

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 needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&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_late_bound_regions(&self) -> bool

True if there are any late-bound regions

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<'tcx> Copy for ParamEnv<'tcx>

impl<'tcx> Eq for ParamEnv<'tcx>

impl<'tcx> StructuralEq for ParamEnv<'tcx>

impl<'tcx> StructuralPartialEq for ParamEnv<'tcx>

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: 8 bytes