Struct ParamEnv

pub struct ParamEnv<'tcx> {
    packed: CopyTaggedPtr<Clauses<'tcx>, ParamTag, true>,
}

When interacting with the type system we must provide information about the environment. ParamEnv is the type that represents this information. See the dev guide chapter for more information.

Fields

packed: CopyTaggedPtr<Clauses<'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. In majority of cases it is incorrect to use an empty environment. See the dev guide section for information on what a ParamEnv is and how to acquire one.

pub fn caller_bounds(self) -> Clauses<'tcx>

pub fn reveal(self) -> Reveal

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: Clauses<'tcx>, reveal: Reveal) -> Self

Construct a trait environment with the given set of predicates.

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<TyCtxt<'tcx>>>( self, value: T, ) -> ParamEnvAnd<'tcx, T>

Creates a pair of param-env and value for use in queries.

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, D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<D> for ParamEnv<'tcx>

fn decode(d: &mut D) -> Self

impl<'tcx, E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<E> for ParamEnv<'tcx>

fn encode(&self, e: &mut E)

impl<'tcx> EraseType for ParamEnv<'tcx>

type Result = [u8; 8]

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>

type Cache<V> = DefaultCache<ParamEnv<'tcx>, V>

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?

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_def_id(&self) -> Option<DefId>

impl<'tcx> ParamEnv<TyCtxt<'tcx>> for ParamEnv<'tcx>

fn reveal(self) -> Reveal

fn caller_bounds(self) -> impl IntoIterator<Item = Clause<'tcx>>

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

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

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

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

fn try_fold_with<F: FallibleTypeFolder<TyCtxt<'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>(self, folder: &mut F) -> Self

where F: TypeFolder<I>,

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

fn visit_with<V: TypeVisitor<TyCtxt<'tcx>>>(&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).

impl<'tcx> Copy for ParamEnv<'tcx>

impl<'tcx> Eq 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