Struct rustc_middle::ty::query::TyCtxtAt

pub struct TyCtxtAt<'tcx> {
    pub tcx: TyCtxt<'tcx>,
    pub span: Span,
}

Fields

tcx: TyCtxt<'tcx>

span: Span

Implementations

impl<'tcx> TyCtxtAt<'tcx>

pub fn layout_of(
    self,
    param_env_and_ty: ParamEnvAnd<'tcx, Ty<'tcx>>
) -> Result<TyAndLayout<'tcx>, LayoutError<'tcx>>

Computes the layout of a type. Note that this implicitly executes in "reveal all" mode.

impl<'tcx> TyCtxtAt<'tcx>

pub fn trigger_delay_span_bug(self, key: impl IntoQueryParam<DefId>)

pub fn hir_crate(self, key: CrateNum) -> &'tcx Crate<'tcx>

Represents crate as a whole (as distinct from the top-level crate module). If you call hir_crate (e.g., indirectly by calling tcx.hir().krate()), we will have to assume that any change means that you need to be recompiled. This is because the hir_crate query gives you access to all other items. To avoid this fate, do not call tcx.hir().krate(); instead, prefer wrappers like tcx.visit_all_items_in_krate().

pub fn index_hir(self, key: CrateNum) -> &'tcx IndexedHir<'tcx>

The indexed HIR. This can be conveniently accessed by tcx.hir(). Avoid calling this query directly.

pub fn hir_module_items(self, key: LocalDefId) -> &'tcx ModuleItems

The items in a module.

This can be conveniently accessed by tcx.hir().visit_item_likes_in_module. Avoid calling this query directly.

pub fn hir_owner(self, key: LocalDefId) -> Option<&'tcx Owner<'tcx>>

Gives access to the HIR node for the HIR owner key.

This can be conveniently accessed by methods on tcx.hir(). Avoid calling this query directly.

pub fn hir_owner_nodes(self, key: LocalDefId) -> Option<&'tcx OwnerNodes<'tcx>>

Gives access to the HIR nodes and bodies inside the HIR owner key.

This can be conveniently accessed by methods on tcx.hir(). Avoid calling this query directly.

pub fn opt_const_param_of(self, key: LocalDefId) -> Option<DefId>

Computes the DefId of the corresponding const parameter in case the key is a const argument and returns None otherwise.

let a = foo::<7>();
//            ^ Calling `opt_const_param_of` for this argument,

fn foo<const N: usize>()
//           ^ returns this `DefId`.

fn bar() {
// ^ While calling `opt_const_param_of` for other bodies returns `None`.
}

pub fn type_of(self, key: impl IntoQueryParam<DefId>) -> &'tcx TyS<'tcx>

Records the type of every item.

pub fn analysis(self, key: CrateNum) -> Result<(), ErrorReported>

pub fn generics_of(self, key: impl IntoQueryParam<DefId>) -> &'tcx Generics

Maps from the DefId of an item (trait/struct/enum/fn) to its associated generics.

pub fn predicates_of(
    self,
    key: impl IntoQueryParam<DefId>
) -> GenericPredicates<'tcx>

Maps from the DefId of an item (trait/struct/enum/fn) to the predicates (where-clauses) that must be proven true in order to reference it. This is almost always the "predicates query" that you want.

predicates_of builds on predicates_defined_on -- in fact, it is almost always the same as that query, except for the case of traits. For traits, predicates_of contains an additional Self: Trait<...> predicate that users don't actually write. This reflects the fact that to invoke the trait (e.g., via Default::default) you must supply types that actually implement the trait. (However, this extra predicate gets in the way of some checks, which are intended to operate over only the actual where-clauses written by the user.)

pub fn explicit_item_bounds(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx [(Predicate<'tcx>, Span)]

Returns the list of bounds that can be used for SelectionCandidate::ProjectionCandidate(_) and ProjectionTyCandidate::TraitDef. Specifically this is the bounds written on the trait's type definition, or those after the impl keyword

type X: Bound + 'lt
//      ^^^^^^^^^^^
impl Debug + Display
//   ^^^^^^^^^^^^^^^

key is the DefId of the associated type or opaque type.

Bounds from the parent (e.g. with nested impl trait) are not included.

pub fn item_bounds(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx List<Predicate<'tcx>>

Elaborated version of the predicates from explicit_item_bounds.

For example:

trait MyTrait {
    type MyAType: Eq + ?Sized;
}

explicit_item_bounds returns [<Self as MyTrait>::MyAType: Eq], and item_bounds returns

[
    <Self as Trait>::MyAType: Eq,
    <Self as Trait>::MyAType: PartialEq<<Self as Trait>::MyAType>
]

Bounds from the parent (e.g. with nested impl trait) are not included.

pub fn projection_ty_from_predicates(
    self,
    key: (DefId, DefId)
) -> Option<ProjectionTy<'tcx>>

pub fn native_libraries(self, key: CrateNum) -> Rc<Vec<NativeLib, Global>>

pub fn lint_levels(self, key: CrateNum) -> &'tcx LintLevelMap

pub fn parent_module_from_def_id(self, key: LocalDefId) -> LocalDefId

pub fn expn_that_defined(self, key: impl IntoQueryParam<DefId>) -> ExpnId

Internal helper query. Use tcx.expansion_that_defined instead

pub fn is_panic_runtime(self, key: CrateNum) -> bool

pub fn mir_keys(
    self,
    key: CrateNum
) -> &'tcx HashSet<LocalDefId, BuildHasherDefault<FxHasher>>

Set of all the DefIds in this crate that have MIR associated with them. This includes all the body owners, but also things like struct constructors.

pub fn mir_const_qualif(self, key: impl IntoQueryParam<DefId>) -> ConstQualifs

Maps DefId's that have an associated mir::Body to the result of the MIR const-checking pass. This is the set of qualifs in the final value of a const.

pub fn mir_const_qualif_const_arg(
    self,
    key: (LocalDefId, DefId)
) -> ConstQualifs

pub fn mir_built(
    self,
    key: WithOptConstParam<LocalDefId>
) -> &'tcx Steal<Body<'tcx>>

Fetch the MIR for a given DefId right after it's built - this includes unreachable code.

pub fn mir_const(
    self,
    key: WithOptConstParam<LocalDefId>
) -> &'tcx Steal<Body<'tcx>>

Fetch the MIR for a given DefId up till the point where it is ready for const qualification.

See the README for the mir module for details.

pub fn mir_abstract_const(
    self,
    key: impl IntoQueryParam<DefId>
) -> Result<Option<&'tcx [Node<'tcx>]>, ErrorReported>

Try to build an abstract representation of the given constant.

pub fn mir_abstract_const_of_const_arg(
    self,
    key: (LocalDefId, DefId)
) -> Result<Option<&'tcx [Node<'tcx>]>, ErrorReported>

Try to build an abstract representation of the given constant.

pub fn try_unify_abstract_consts(
    self,
    key: ((WithOptConstParam<DefId>, SubstsRef<'tcx>), (WithOptConstParam<DefId>, SubstsRef<'tcx>))
) -> bool

pub fn mir_drops_elaborated_and_const_checked(
    self,
    key: WithOptConstParam<LocalDefId>
) -> &'tcx Steal<Body<'tcx>>

pub fn mir_promoted(
    self,
    key: WithOptConstParam<LocalDefId>
) -> (&'tcx Steal<Body<'tcx>>, &'tcx Steal<IndexVec<Promoted, Body<'tcx>>>)

pub fn optimized_mir(self, key: impl IntoQueryParam<DefId>) -> &'tcx Body<'tcx>

MIR after our optimization passes have run. This is MIR that is ready for codegen. This is also the only query that can fetch non-local MIR, at present.

pub fn optimized_mir_of_const_arg(
    self,
    key: (LocalDefId, DefId)
) -> &'tcx Body<'tcx>

pub fn coverageinfo(self, key: impl IntoQueryParam<DefId>) -> &'tcx CoverageInfo

Returns coverage summary info for a function, after executing the InstrumentCoverage MIR pass (assuming the -Zinstrument-coverage option is enabled).

pub fn covered_file_name(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx Option<Symbol>

Returns the name of the file that contains the function body, if instrumented for coverage.

pub fn covered_code_regions(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx Vec<&'tcx CodeRegion, Global>

Returns the CodeRegions for a function that has instrumented coverage, in case the function was optimized out before codegen, and before being added to the Coverage Map.

pub fn promoted_mir(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx IndexVec<Promoted, Body<'tcx>>

The DefId is the DefId of the containing MIR body. Promoteds do not have their own DefId. This function returns all promoteds in the specified body. The body references promoteds by the DefId and the mir::Promoted index. This is necessary, because after inlining a body may refer to promoteds from other bodies. In that case you still need to use the DefId of the original body.

pub fn promoted_mir_of_const_arg(
    self,
    key: (LocalDefId, DefId)
) -> &'tcx IndexVec<Promoted, Body<'tcx>>

pub fn erase_regions_ty(self, key: Ty<'tcx>) -> &'tcx TyS<'tcx>

Erases regions from ty to yield a new type. Normally you would just use tcx.erase_regions(value), however, which uses this query as a kind of cache.

pub fn wasm_import_module_map(
    self,
    key: CrateNum
) -> &'tcx HashMap<DefId, String, BuildHasherDefault<FxHasher>>

pub fn predicates_defined_on(
    self,
    key: impl IntoQueryParam<DefId>
) -> GenericPredicates<'tcx>

Maps from the DefId of an item (trait/struct/enum/fn) to the predicates (where-clauses) directly defined on it. This is equal to the explicit_predicates_of predicates plus the inferred_outlives_of predicates.

pub fn trait_explicit_predicates_and_bounds(
    self,
    key: LocalDefId
) -> GenericPredicates<'tcx>

Returns everything that looks like a predicate written explicitly by the user on a trait item.

Traits are unusual, because predicates on associated types are converted into bounds on that type for backwards compatibility:

trait X where Self::U: Copy { type U; }

becomes

trait X { type U: Copy; }

explicit_predicates_of and explicit_item_bounds will then take the appropriate subsets of the predicates here.

pub fn explicit_predicates_of(
    self,
    key: impl IntoQueryParam<DefId>
) -> GenericPredicates<'tcx>

Returns the predicates written explicitly by the user.

pub fn inferred_outlives_of(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx [(Predicate<'tcx>, Span)]

Returns the inferred outlives predicates (e.g., for struct Foo<'a, T> { x: &'a T }, this would return T: 'a).

pub fn super_predicates_of(
    self,
    key: impl IntoQueryParam<DefId>
) -> GenericPredicates<'tcx>

Maps from the DefId of a trait to the list of super-predicates. This is a subset of the full list of predicates. We store these in a separate map because we must evaluate them even during type conversion, often before the full predicates are available (note that supertraits have additional acyclicity requirements).

pub fn type_param_predicates(
    self,
    key: (DefId, LocalDefId)
) -> GenericPredicates<'tcx>

To avoid cycles within the predicates of a single item we compute per-type-parameter predicates for resolving T::AssocTy.

pub fn trait_def(self, key: impl IntoQueryParam<DefId>) -> &'tcx TraitDef

pub fn adt_def(self, key: impl IntoQueryParam<DefId>) -> &'tcx AdtDef

pub fn adt_destructor(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<Destructor>

pub fn adt_sized_constraint(
    self,
    key: impl IntoQueryParam<DefId>
) -> AdtSizedConstraint<'tcx>

pub fn adt_dtorck_constraint(
    self,
    key: impl IntoQueryParam<DefId>
) -> Result<DtorckConstraint<'tcx>, NoSolution>

pub fn is_const_fn_raw(self, key: impl IntoQueryParam<DefId>) -> bool

Returns true if this is a const fn, use the is_const_fn to know whether your crate actually sees it as const fn (e.g., the const-fn-ness might be unstable and you might not have the feature gate active).

Do not call this function manually. It is only meant to cache the base data for the is_const_fn function.

pub fn is_const_impl_raw(self, key: impl IntoQueryParam<DefId>) -> bool

Returns true if this is a const impl. Do not call this function manually.

This query caches the base data for the is_const_impl helper function, which also takes into account stability attributes (e.g., #[rustc_const_unstable]).

pub fn asyncness(self, key: impl IntoQueryParam<DefId>) -> IsAsync

pub fn is_promotable_const_fn(self, key: impl IntoQueryParam<DefId>) -> bool

Returns true if calls to the function may be promoted.

This is either because the function is e.g., a tuple-struct or tuple-variant constructor, or because it has the #[rustc_promotable] attribute. The attribute should be removed in the future in favour of some form of check which figures out whether the function does not inspect the bits of any of its arguments (so is essentially just a constructor function).

pub fn is_foreign_item(self, key: impl IntoQueryParam<DefId>) -> bool

Returns true if this is a foreign item (i.e., linked via extern { ... }).

pub fn static_mutability(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<Mutability>

Returns Some(mutability) if the node pointed to by def_id is a static item.

pub fn generator_kind(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<GeneratorKind>

Returns Some(generator_kind) if the node pointed to by def_id is a generator.

pub fn crate_variances(self, key: CrateNum) -> &'tcx CrateVariancesMap<'tcx>

Gets a map with the variance of every item; use item_variance instead.

pub fn variances_of(self, key: impl IntoQueryParam<DefId>) -> &'tcx [Variance]

Maps from the DefId of a type or region parameter to its (inferred) variance.

pub fn inferred_outlives_crate(
    self,
    key: CrateNum
) -> &'tcx CratePredicatesMap<'tcx>

Maps from thee DefId of a type to its (inferred) outlives.

pub fn associated_item_def_ids(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx [DefId]

Maps from an impl/trait DefId to a list of the DefId`s of its items.

pub fn associated_item(self, key: impl IntoQueryParam<DefId>) -> &'tcx AssocItem

Maps from a trait item to the trait item "descriptor".

pub fn associated_items(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx AssociatedItems<'tcx>

Collects the associated items defined on a trait or impl.

pub fn impl_trait_ref(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<TraitRef<'tcx>>

pub fn impl_polarity(self, key: impl IntoQueryParam<DefId>) -> ImplPolarity

pub fn issue33140_self_ty(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<&'tcx TyS<'tcx>>

pub fn inherent_impls(self, key: impl IntoQueryParam<DefId>) -> &'tcx [DefId]

Maps a DefId of a type to a list of its inherent impls. Contains implementations of methods that are inherent to a type. Methods in these implementations don't need to be exported.

pub fn unsafety_check_result(self, key: LocalDefId) -> &'tcx UnsafetyCheckResult

The result of unsafety-checking this LocalDefId.

pub fn unsafety_check_result_for_const_arg(
    self,
    key: (LocalDefId, DefId)
) -> &'tcx UnsafetyCheckResult

pub fn unsafe_derive_on_repr_packed(self, key: LocalDefId)

HACK: when evaluated, this reports a "unsafe derive on repr(packed)" error.

Unsafety checking is executed for each method separately, but we only want to emit this error once per derive. As there are some impls with multiple methods, we use a query for deduplication.

pub fn fn_sig(self, key: impl IntoQueryParam<DefId>) -> Binder<FnSig<'tcx>>

The signature of functions.

pub fn lint_mod(self, key: LocalDefId)

pub fn check_mod_attrs(self, key: LocalDefId)

Checks the attributes in the module.

pub fn check_mod_unstable_api_usage(self, key: LocalDefId)

pub fn check_mod_const_bodies(self, key: LocalDefId)

Checks the const bodies in the module for illegal operations (e.g. if or loop).

pub fn check_mod_loops(self, key: LocalDefId)

Checks the loops in the module.

pub fn check_mod_naked_functions(self, key: LocalDefId)

pub fn check_mod_item_types(self, key: LocalDefId)

pub fn check_mod_privacy(self, key: LocalDefId)

pub fn check_mod_intrinsics(self, key: LocalDefId)

pub fn check_mod_liveness(self, key: LocalDefId)

pub fn check_mod_impl_wf(self, key: LocalDefId)

pub fn collect_mod_item_types(self, key: LocalDefId)

pub fn coerce_unsized_info(
    self,
    key: impl IntoQueryParam<DefId>
) -> CoerceUnsizedInfo

Caches CoerceUnsized kinds for impls on custom types.

pub fn typeck_item_bodies(self, key: CrateNum)

pub fn typeck(self, key: LocalDefId) -> &'tcx TypeckResults<'tcx>

pub fn typeck_const_arg(
    self,
    key: (LocalDefId, DefId)
) -> &'tcx TypeckResults<'tcx>

pub fn diagnostic_only_typeck(
    self,
    key: LocalDefId
) -> &'tcx TypeckResults<'tcx>

pub fn used_trait_imports(
    self,
    key: LocalDefId
) -> &'tcx HashSet<LocalDefId, BuildHasherDefault<FxHasher>>

pub fn has_typeck_results(self, key: impl IntoQueryParam<DefId>) -> bool

pub fn coherent_trait(self, key: impl IntoQueryParam<DefId>)

pub fn mir_borrowck(self, key: LocalDefId) -> &'tcx BorrowCheckResult<'tcx>

Borrow-checks the function body. If this is a closure, returns additional requirements that the closure's creator must verify.

pub fn mir_borrowck_const_arg(
    self,
    key: (LocalDefId, DefId)
) -> &'tcx BorrowCheckResult<'tcx>

pub fn crate_inherent_impls(self, key: CrateNum) -> &'tcx CrateInherentImpls

Gets a complete map from all types to their inherent impls. Not meant to be used directly outside of coherence. (Defined only for LOCAL_CRATE.)

pub fn crate_inherent_impls_overlap_check(self, key: CrateNum)

Checks all types in the crate for overlap in their inherent impls. Reports errors. Not meant to be used directly outside of coherence. (Defined only for LOCAL_CRATE.)

pub fn eval_to_allocation_raw(
    self,
    key: ParamEnvAnd<'tcx, GlobalId<'tcx>>
) -> Result<ConstAlloc<'tcx>, ErrorHandled>

Evaluates a constant and returns the computed allocation.

Do not use this directly, use the tcx.eval_static_initializer wrapper.

pub fn eval_to_const_value_raw(
    self,
    key: ParamEnvAnd<'tcx, GlobalId<'tcx>>
) -> Result<ConstValue<'tcx>, ErrorHandled>

Evaluates const items or anonymous constants (such as enum variant explicit discriminants or array lengths) into a representation suitable for the type system and const generics.

Do not use this directly, use one of the following wrappers: tcx.const_eval_poly, tcx.const_eval_resolve, tcx.const_eval_instance, or tcx.const_eval_global_id.

pub fn destructure_const(
    self,
    key: ParamEnvAnd<'tcx, &'tcx Const<'tcx>>
) -> DestructuredConst<'tcx>

Destructure a constant ADT or array into its variant index and its field values.

pub fn deref_const(
    self,
    key: ParamEnvAnd<'tcx, &'tcx Const<'tcx>>
) -> &'tcx Const<'tcx>

Dereference a constant reference or raw pointer and turn the result into a constant again.

pub fn const_caller_location(self, key: (Symbol, u32, u32)) -> ConstValue<'tcx>

pub fn lit_to_const(
    self,
    key: LitToConstInput<'tcx>
) -> Result<&'tcx Const<'tcx>, LitToConstError>

pub fn check_match(self, key: impl IntoQueryParam<DefId>)

pub fn privacy_access_levels(self, key: CrateNum) -> &'tcx AccessLevels<HirId>

Performs part of the privacy check and computes "access levels".

pub fn check_private_in_public(self, key: CrateNum)

pub fn reachable_set(
    self,
    key: CrateNum
) -> &'tcx HashSet<LocalDefId, BuildHasherDefault<FxHasher>>

pub fn region_scope_tree(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx ScopeTree

Per-body region::ScopeTree. The DefId should be the owner DefId for the body; in the case of closures, this will be redirected to the enclosing function.

pub fn mir_shims(self, key: InstanceDef<'tcx>) -> &'tcx Body<'tcx>

pub fn symbol_name(self, key: Instance<'tcx>) -> SymbolName<'tcx>

The symbol_name query provides the symbol name for calling a given instance from the local crate. In particular, it will also look up the correct symbol name of instances from upstream crates.

pub fn def_kind(self, key: impl IntoQueryParam<DefId>) -> DefKind

pub fn def_span(self, key: impl IntoQueryParam<DefId>) -> Span

pub fn lookup_stability(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<&'tcx Stability>

pub fn lookup_const_stability(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<&'tcx ConstStability>

pub fn lookup_deprecation_entry(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<DeprecationEntry>

pub fn item_attrs(self, key: impl IntoQueryParam<DefId>) -> &'tcx [Attribute]

pub fn codegen_fn_attrs(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx CodegenFnAttrs

pub fn fn_arg_names(self, key: impl IntoQueryParam<DefId>) -> &'tcx [Ident]

pub fn rendered_const(self, key: impl IntoQueryParam<DefId>) -> String

Gets the rendered value of the specified constant or associated constant. Used by rustdoc.

pub fn impl_parent(self, key: impl IntoQueryParam<DefId>) -> Option<DefId>

pub fn trait_of_item(self, key: impl IntoQueryParam<DefId>) -> Option<DefId>

pub fn is_mir_available(self, key: impl IntoQueryParam<DefId>) -> bool

pub fn vtable_methods(
    self,
    key: PolyTraitRef<'tcx>
) -> &'tcx [Option<(DefId, &'tcx List<GenericArg<'tcx>>)>]

pub fn codegen_fulfill_obligation(
    self,
    key: (ParamEnv<'tcx>, PolyTraitRef<'tcx>)
) -> Result<ImplSource<'tcx, ()>, ErrorReported>

pub fn all_local_trait_impls(
    self,
    key: CrateNum
) -> &'tcx BTreeMap<DefId, Vec<HirId, Global>>

pub fn trait_impls_of(self, key: impl IntoQueryParam<DefId>) -> &'tcx TraitImpls

pub fn specialization_graph_of(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx Graph

pub fn object_safety_violations(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx [ObjectSafetyViolation]

pub fn param_env(self, key: impl IntoQueryParam<DefId>) -> ParamEnv<'tcx>

Gets the ParameterEnvironment for a given item; this environment will be in "user-facing" mode, meaning that it is suitable for type-checking etc, and it does not normalize specializable associated types. This is almost always what you want, unless you are doing MIR optimizations, in which case you

pub fn param_env_reveal_all_normalized(
    self,
    key: impl IntoQueryParam<DefId>
) -> ParamEnv<'tcx>

Like param_env, but returns the ParamEnv in Reveal::Allmode. Prefer this overtcx.param_env(def_id).with_reveal_all_normalized(tcx)`, as this method is more efficient.

pub fn is_copy_raw(self, key: ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool

Trait selection queries. These are best used by invoking ty.is_copy_modulo_regions(), ty.is_copy(), etc, since that will prune the environment where possible.

pub fn is_sized_raw(self, key: ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool

Query backing TyS::is_sized.

pub fn is_freeze_raw(self, key: ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool

Query backing TyS::is_freeze.

pub fn needs_drop_raw(self, key: ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool

Query backing TyS::needs_drop.

pub fn has_structural_eq_impls(self, key: Ty<'tcx>) -> bool

Query backing TyS::is_structural_eq_shallow.

This is only correct for ADTs. Call is_structural_eq_shallow to handle all types correctly.

pub fn adt_drop_tys(
    self,
    key: impl IntoQueryParam<DefId>
) -> Result<&'tcx List<&'tcx TyS<'tcx>>, AlwaysRequiresDrop>

A list of types where the ADT requires drop if and only if any of those types require drop. If the ADT is known to always need drop then Err(AlwaysRequiresDrop) is returned.

pub fn layout_raw(
    self,
    key: ParamEnvAnd<'tcx, Ty<'tcx>>
) -> Result<&'tcx Layout, LayoutError<'tcx>>

pub fn dylib_dependency_formats(
    self,
    key: CrateNum
) -> &'tcx [(CrateNum, LinkagePreference)]

pub fn dependency_formats(
    self,
    key: CrateNum
) -> Rc<Vec<(CrateType, Vec<Linkage, Global>), Global>>

pub fn is_compiler_builtins(self, key: CrateNum) -> bool

pub fn has_global_allocator(self, key: CrateNum) -> bool

pub fn has_panic_handler(self, key: CrateNum) -> bool

pub fn is_profiler_runtime(self, key: CrateNum) -> bool

pub fn panic_strategy(self, key: CrateNum) -> PanicStrategy

pub fn is_no_builtins(self, key: CrateNum) -> bool

pub fn symbol_mangling_version(self, key: CrateNum) -> SymbolManglingVersion

pub fn extern_crate(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<&'tcx ExternCrate>

pub fn specializes(self, key: (DefId, DefId)) -> bool

pub fn in_scope_traits_map(
    self,
    key: LocalDefId
) -> Option<&'tcx HashMap<ItemLocalId, StableVec<TraitCandidate>, BuildHasherDefault<FxHasher>>>

pub fn module_exports(
    self,
    key: LocalDefId
) -> Option<&'tcx [Export<LocalDefId>]>

pub fn impl_defaultness(self, key: impl IntoQueryParam<DefId>) -> Defaultness

pub fn check_item_well_formed(self, key: LocalDefId)

pub fn check_trait_item_well_formed(self, key: LocalDefId)

pub fn check_impl_item_well_formed(self, key: LocalDefId)

pub fn reachable_non_generics(
    self,
    key: CrateNum
) -> &'tcx HashMap<DefId, SymbolExportLevel, BuildHasherDefault<FxHasher>>

pub fn is_reachable_non_generic(self, key: impl IntoQueryParam<DefId>) -> bool

pub fn is_unreachable_local_definition(
    self,
    key: impl IntoQueryParam<DefId>
) -> bool

pub fn upstream_monomorphizations(
    self,
    key: CrateNum
) -> &'tcx HashMap<DefId, HashMap<&'tcx List<GenericArg<'tcx>>, CrateNum, BuildHasherDefault<FxHasher>>, BuildHasherDefault<FxHasher>>

The entire set of monomorphizations the local crate can safely link to because they are exported from upstream crates. Do not depend on this directly, as its value changes anytime a monomorphization gets added or removed in any upstream crate. Instead use the narrower upstream_monomorphizations_for, upstream_drop_glue_for, or, even better, Instance::upstream_monomorphization().

pub fn upstream_monomorphizations_for(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<&'tcx HashMap<&'tcx List<GenericArg<'tcx>>, CrateNum, BuildHasherDefault<FxHasher>>>

Returns the set of upstream monomorphizations available for the generic function identified by the given def_id. The query makes sure to make a stable selection if the same monomorphization is available in multiple upstream crates.

You likely want to call Instance::upstream_monomorphization() instead of invoking this query directly.

pub fn upstream_drop_glue_for(self, key: SubstsRef<'tcx>) -> Option<CrateNum>

Returns the upstream crate that exports drop-glue for the given type (substs is expected to be a single-item list containing the type one wants drop-glue for).

This is a subset of upstream_monomorphizations_for in order to increase dep-tracking granularity. Otherwise adding or removing any type with drop-glue in any upstream crate would invalidate all functions calling drop-glue of an upstream type.

You likely want to call Instance::upstream_monomorphization() instead of invoking this query directly.

NOTE: This query could easily be extended to also support other common functions that have are large set of monomorphizations (like Clone::clone for example).

pub fn foreign_modules(
    self,
    key: CrateNum
) -> Rc<HashMap<DefId, ForeignModule, BuildHasherDefault<FxHasher>>>

pub fn entry_fn(self, key: CrateNum) -> Option<(LocalDefId, EntryFnType)>

Identifies the entry-point (e.g., the main function) for a given crate, returning None if there is no entry point (such as for library crates).

pub fn plugin_registrar_fn(self, key: CrateNum) -> Option<DefId>

pub fn proc_macro_decls_static(self, key: CrateNum) -> Option<DefId>

pub fn crate_disambiguator(self, key: CrateNum) -> CrateDisambiguator

pub fn crate_hash(self, key: CrateNum) -> Svh

pub fn crate_host_hash(self, key: CrateNum) -> Option<Svh>

pub fn original_crate_name(self, key: CrateNum) -> Symbol

pub fn extra_filename(self, key: CrateNum) -> String

pub fn crate_extern_paths(self, key: CrateNum) -> Vec<PathBuf, Global>

pub fn implementations_of_trait(
    self,
    key: (CrateNum, DefId)
) -> &'tcx [(DefId, Option<SimplifiedTypeGen<DefId>>)]

pub fn all_trait_implementations(
    self,
    key: CrateNum
) -> &'tcx [(DefId, Option<SimplifiedTypeGen<DefId>>)]

pub fn dllimport_foreign_items(
    self,
    key: CrateNum
) -> &'tcx HashSet<DefId, BuildHasherDefault<FxHasher>>

pub fn is_dllimport_foreign_item(self, key: impl IntoQueryParam<DefId>) -> bool

pub fn is_statically_included_foreign_item(
    self,
    key: impl IntoQueryParam<DefId>
) -> bool

pub fn native_library_kind(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<NativeLibKind>

pub fn link_args(self, key: CrateNum) -> Rc<Vec<String, Global>>

pub fn resolve_lifetimes(self, key: CrateNum) -> &'tcx ResolveLifetimes

Lifetime resolution. See middle::resolve_lifetimes.

pub fn named_region_map(
    self,
    key: LocalDefId
) -> Option<&'tcx HashMap<ItemLocalId, Region, BuildHasherDefault<FxHasher>>>

pub fn is_late_bound_map(
    self,
    key: LocalDefId
) -> Option<&'tcx HashSet<ItemLocalId, BuildHasherDefault<FxHasher>>>

pub fn object_lifetime_defaults_map(
    self,
    key: LocalDefId
) -> Option<&'tcx HashMap<ItemLocalId, Vec<Set1<Region>, Global>, BuildHasherDefault<FxHasher>>>

pub fn visibility(self, key: impl IntoQueryParam<DefId>) -> Visibility

pub fn dep_kind(self, key: CrateNum) -> CrateDepKind

pub fn crate_name(self, key: CrateNum) -> Symbol

pub fn item_children(
    self,
    key: impl IntoQueryParam<DefId>
) -> &'tcx [Export<HirId>]

pub fn extern_mod_stmt_cnum(self, key: LocalDefId) -> Option<CrateNum>

pub fn get_lib_features(self, key: CrateNum) -> &'tcx LibFeatures

pub fn defined_lib_features(
    self,
    key: CrateNum
) -> &'tcx [(Symbol, Option<Symbol>)]

pub fn get_lang_items(self, key: CrateNum) -> &'tcx LanguageItems

Returns the lang items defined in another crate by loading it from metadata.

pub fn all_diagnostic_items(
    self,
    key: CrateNum
) -> &'tcx HashMap<Symbol, DefId, BuildHasherDefault<FxHasher>>

Returns all diagnostic items defined in all crates.

pub fn defined_lang_items(self, key: CrateNum) -> &'tcx [(DefId, usize)]

Returns the lang items defined in another crate by loading it from metadata.

pub fn diagnostic_items(
    self,
    key: CrateNum
) -> &'tcx HashMap<Symbol, DefId, BuildHasherDefault<FxHasher>>

Returns the diagnostic items defined in a crate.

pub fn missing_lang_items(self, key: CrateNum) -> &'tcx [LangItem]

pub fn visible_parent_map(
    self,
    key: CrateNum
) -> &'tcx HashMap<DefId, DefId, BuildHasherDefault<FxHasher>>

pub fn trimmed_def_paths(
    self,
    key: CrateNum
) -> &'tcx HashMap<DefId, Symbol, BuildHasherDefault<FxHasher>>

pub fn missing_extern_crate_item(self, key: CrateNum) -> bool

pub fn used_crate_source(self, key: CrateNum) -> Rc<CrateSource>

pub fn postorder_cnums(self, key: CrateNum) -> &'tcx [CrateNum]

pub fn upvars_mentioned(
    self,
    key: impl IntoQueryParam<DefId>
) -> Option<&'tcx IndexMap<HirId, Upvar, BuildHasherDefault<FxHasher>>>

pub fn maybe_unused_trait_import(self, key: LocalDefId) -> bool

pub fn maybe_unused_extern_crates(
    self,
    key: CrateNum
) -> &'tcx [(LocalDefId, Span)]

pub fn names_imported_by_glob_use(
    self,
    key: LocalDefId
) -> &'tcx HashSet<Symbol, BuildHasherDefault<FxHasher>>

pub fn stability_index(self, key: CrateNum) -> &'tcx Index<'tcx>

pub fn all_crate_nums(self, key: CrateNum) -> &'tcx [CrateNum]

pub fn all_traits(self, key: CrateNum) -> &'tcx [DefId]

A vector of every trait accessible in the whole crate (i.e., including those from subcrates). This is used only for error reporting.

pub fn exported_symbols(
    self,
    key: CrateNum
) -> &'tcx [(ExportedSymbol<'tcx>, SymbolExportLevel)]

The list of symbols exported from the given crate.

• All names contained in exported_symbols(cnum) are guaranteed to correspond to a publicly visible symbol in cnum machine code.
• The exported_symbols sets of different crates do not intersect.

pub fn collect_and_partition_mono_items(
    self,
    key: CrateNum
) -> (&'tcx HashSet<DefId, BuildHasherDefault<FxHasher>>, &'tcx [CodegenUnit<'tcx>])

pub fn is_codegened_item(self, key: impl IntoQueryParam<DefId>) -> bool

pub fn codegen_unit(self, key: Symbol) -> &'tcx CodegenUnit<'tcx>

pub fn unused_generic_params(
    self,
    key: impl IntoQueryParam<DefId>
) -> FiniteBitSet<u32>

pub fn backend_optimization_level(self, key: CrateNum) -> OptLevel

pub fn output_filenames(self, key: CrateNum) -> Arc<OutputFilenames>

pub fn normalize_projection_ty(
    self,
    key: CanonicalProjectionGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, NormalizationResult<'tcx>>>, NoSolution>

Do not call this query directly: invoke normalize instead.

pub fn normalize_generic_arg_after_erasing_regions(
    self,
    key: ParamEnvAnd<'tcx, GenericArg<'tcx>>
) -> GenericArg<'tcx>

Do not call this query directly: invoke normalize_erasing_regions instead.

pub fn implied_outlives_bounds(
    self,
    key: CanonicalTyGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, Vec<OutlivesBound<'tcx>, Global>>>, NoSolution>

pub fn dropck_outlives(
    self,
    key: CanonicalTyGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, DropckOutlivesResult<'tcx>>>, NoSolution>

Do not call this query directly: invoke infcx.at().dropck_outlives() instead.

pub fn evaluate_obligation(
    self,
    key: CanonicalPredicateGoal<'tcx>
) -> Result<EvaluationResult, OverflowError>

Do not call this query directly: invoke infcx.predicate_may_hold() or infcx.predicate_must_hold() instead.

pub fn evaluate_goal(
    self,
    key: CanonicalChalkEnvironmentAndGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, ()>>, NoSolution>

pub fn type_implements_trait(
    self,
    key: (DefId, Ty<'tcx>, SubstsRef<'tcx>, ParamEnv<'tcx>)
) -> bool

pub fn type_op_ascribe_user_type(
    self,
    key: CanonicalTypeOpAscribeUserTypeGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, ()>>, NoSolution>

Do not call this query directly: part of the Eq type-op

pub fn type_op_eq(
    self,
    key: CanonicalTypeOpEqGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, ()>>, NoSolution>

Do not call this query directly: part of the Eq type-op

pub fn type_op_subtype(
    self,
    key: CanonicalTypeOpSubtypeGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, ()>>, NoSolution>

Do not call this query directly: part of the Subtype type-op

pub fn type_op_prove_predicate(
    self,
    key: CanonicalTypeOpProvePredicateGoal<'tcx>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, ()>>, NoSolution>

Do not call this query directly: part of the ProvePredicate type-op

pub fn type_op_normalize_ty(
    self,
    key: CanonicalTypeOpNormalizeGoal<'tcx, Ty<'tcx>>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, &'tcx TyS<'tcx>>>, NoSolution>

Do not call this query directly: part of the Normalize type-op

pub fn type_op_normalize_predicate(
    self,
    key: CanonicalTypeOpNormalizeGoal<'tcx, Predicate<'tcx>>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, Predicate<'tcx>>>, NoSolution>

Do not call this query directly: part of the Normalize type-op

pub fn type_op_normalize_poly_fn_sig(
    self,
    key: CanonicalTypeOpNormalizeGoal<'tcx, PolyFnSig<'tcx>>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, Binder<FnSig<'tcx>>>>, NoSolution>

Do not call this query directly: part of the Normalize type-op

pub fn type_op_normalize_fn_sig(
    self,
    key: CanonicalTypeOpNormalizeGoal<'tcx, FnSig<'tcx>>
) -> Result<&'tcx Canonical<'tcx, QueryResponse<'tcx, FnSig<'tcx>>>, NoSolution>

Do not call this query directly: part of the Normalize type-op

pub fn subst_and_check_impossible_predicates(
    self,
    key: (DefId, SubstsRef<'tcx>)
) -> bool

pub fn method_autoderef_steps(
    self,
    key: CanonicalTyGoal<'tcx>
) -> MethodAutoderefStepsResult<'tcx>

pub fn supported_target_features(
    self,
    key: CrateNum
) -> &'tcx HashMap<String, Option<Symbol>, BuildHasherDefault<FxHasher>>

pub fn instance_def_size_estimate(self, key: InstanceDef<'tcx>) -> usize

Get an estimate of the size of an InstanceDef based on its MIR for CGU partitioning.

pub fn features_query(self, key: CrateNum) -> &'tcx Features

pub fn resolve_instance(
    self,
    key: ParamEnvAnd<'tcx, (DefId, SubstsRef<'tcx>)>
) -> Result<Option<Instance<'tcx>>, ErrorReported>

Attempt to resolve the given DefId to an Instance, for the given generics args (SubstsRef), returning one of:

• Ok(Some(instance)) on success
• Ok(None) when the SubstsRef are still too generic, and therefore don't allow finding the final Instance
• Err(ErrorReported) when the Instance resolution process couldn't complete due to errors elsewhere - this is distinct from Ok(None) to avoid misleading diagnostics when an error has already been/will be emitted, for the original cause

pub fn resolve_instance_of_const_arg(
    self,
    key: ParamEnvAnd<'tcx, (LocalDefId, DefId, SubstsRef<'tcx>)>
) -> Result<Option<Instance<'tcx>>, ErrorReported>

pub fn normalize_opaque_types(
    self,
    key: &'tcx List<Predicate<'tcx>>
) -> &'tcx List<Predicate<'tcx>>

impl<'tcx> TyCtxtAt<'tcx>

pub fn ty_error(self) -> Ty<'tcx>

Constructs a TyKind::Error type and registers a delay_span_bug to ensure it gets used.

pub fn ty_error_with_message(self, msg: &str) -> Ty<'tcx>

Constructs a TyKind::Error type and registers a delay_span_bug with the given `msg to ensure it gets used.

Methods from Deref<Target = TyCtxt<'tcx>>

Trait Implementations

impl<'tcx> Clone for TyCtxtAt<'tcx>

pub fn clone(&self) -> TyCtxtAt<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Copy for TyCtxtAt<'tcx>

impl<'tcx> Deref for TyCtxtAt<'tcx>

type Target = TyCtxt<'tcx>

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.