Struct rustc_middle::ty::instance::Instance
source · pub struct Instance<'tcx> {
pub def: InstanceDef<'tcx>,
pub substs: SubstsRef<'tcx>,
}
Expand description
A monomorphized InstanceDef
.
Monomorphization happens on-the-fly and no monomorphized MIR is ever created. Instead, this type
simply couples a potentially generic InstanceDef
with some substs, and codegen and const eval
will do all required substitution as they run.
Fields
def: InstanceDef<'tcx>
substs: SubstsRef<'tcx>
Implementations
sourceimpl<'tcx> Instance<'tcx>
impl<'tcx> Instance<'tcx>
fn fn_sig_for_fn_abi(
&self,
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>
) -> PolyFnSig<'tcx>
sourceimpl<'tcx> Instance<'tcx>
impl<'tcx> Instance<'tcx>
sourcepub fn ty(&self, tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>) -> Ty<'tcx>
pub fn ty(&self, tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>) -> Ty<'tcx>
Returns the Ty
corresponding to this Instance
, with generic substitutions applied and
lifetimes erased, allowing a ParamEnv
to be specified for use during normalization.
sourcepub fn upstream_monomorphization(&self, tcx: TyCtxt<'tcx>) -> Option<CrateNum>
pub fn upstream_monomorphization(&self, tcx: TyCtxt<'tcx>) -> Option<CrateNum>
Finds a crate that contains a monomorphization of this instance that
can be linked to from the local crate. A return value of None
means
no upstream crate provides such an exported monomorphization.
This method already takes into account the global -Zshare-generics
setting, always returning None
if share-generics
is off.
sourceimpl<'tcx> Instance<'tcx>
impl<'tcx> Instance<'tcx>
pub fn new(def_id: DefId, substs: SubstsRef<'tcx>) -> Instance<'tcx>
pub fn mono(tcx: TyCtxt<'tcx>, def_id: DefId) -> Instance<'tcx>
pub fn def_id(&self) -> DefId
sourcepub fn resolve(
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
def_id: DefId,
substs: SubstsRef<'tcx>
) -> Result<Option<Instance<'tcx>>, ErrorGuaranteed>
pub fn resolve(
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
def_id: DefId,
substs: SubstsRef<'tcx>
) -> Result<Option<Instance<'tcx>>, ErrorGuaranteed>
Resolves a (def_id, substs)
pair to an (optional) instance – most commonly,
this is used to find the precise code that will run for a trait method invocation,
if known.
Returns Ok(None)
if we cannot resolve Instance
to a specific instance.
For example, in a context like this,
fn foo<T: Debug>(t: T) { ... }
trying to resolve Debug::fmt
applied to T
will yield Ok(None)
, because we do not
know what code ought to run. (Note that this setting is also affected by the
RevealMode
in the parameter environment.)
Presuming that coherence and type-check have succeeded, if this method is invoked
in a monomorphic context (i.e., like during codegen), then it is guaranteed to return
Ok(Some(instance))
.
Returns Err(ErrorGuaranteed)
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_opt_const_arg(
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
def: WithOptConstParam<DefId>,
substs: SubstsRef<'tcx>
) -> Result<Option<Instance<'tcx>>, ErrorGuaranteed>
pub fn resolve_for_fn_ptr(
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
def_id: DefId,
substs: SubstsRef<'tcx>
) -> Option<Instance<'tcx>>
pub fn resolve_for_vtable(
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
def_id: DefId,
substs: SubstsRef<'tcx>
) -> Option<Instance<'tcx>>
pub fn resolve_closure(
tcx: TyCtxt<'tcx>,
def_id: DefId,
substs: SubstsRef<'tcx>,
requested_kind: ClosureKind
) -> Option<Instance<'tcx>>
pub fn resolve_drop_in_place(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> Instance<'tcx>
pub fn fn_once_adapter_instance(
tcx: TyCtxt<'tcx>,
closure_did: DefId,
substs: SubstsRef<'tcx>
) -> Option<Instance<'tcx>>
sourcefn substs_for_mir_body(&self) -> Option<SubstsRef<'tcx>>
fn substs_for_mir_body(&self) -> Option<SubstsRef<'tcx>>
Depending on the kind of InstanceDef
, the MIR body associated with an
instance is expressed in terms of the generic parameters of self.def_id()
, and in other
cases the MIR body is expressed in terms of the types found in the substitution array.
In the former case, we want to substitute those generic types and replace them with the
values from the substs when monomorphizing the function body. But in the latter case, we
don’t want to do that substitution, since it has already been done effectively.
This function returns Some(substs)
in the former case and None
otherwise – i.e., if
this function returns None
, then the MIR body does not require substitution during
codegen.
pub fn subst_mir<T>(&self, tcx: TyCtxt<'tcx>, v: &T) -> Twhere
T: TypeFoldable<'tcx> + Copy,
pub fn subst_mir_and_normalize_erasing_regions<T>(
&self,
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
v: T
) -> Twhere
T: TypeFoldable<'tcx> + Clone,
pub fn try_subst_mir_and_normalize_erasing_regions<T>(
&self,
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
v: T
) -> Result<T, NormalizationError<'tcx>>where
T: TypeFoldable<'tcx> + Clone,
sourcepub fn polymorphize(self, tcx: TyCtxt<'tcx>) -> Self
pub fn polymorphize(self, tcx: TyCtxt<'tcx>) -> Self
Returns a new Instance
where generic parameters in instance.substs
are replaced by
identity parameters if they are determined to be unused in instance.def
.
Trait Implementations
sourceimpl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Instance<'tcx>
impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Instance<'tcx>
fn hash_stable(
&self,
__hcx: &mut StableHashingContext<'__ctx>,
__hasher: &mut StableHasher
)
sourceimpl<'tcx> PartialEq<Instance<'tcx>> for Instance<'tcx>
impl<'tcx> PartialEq<Instance<'tcx>> for Instance<'tcx>
sourceimpl<'tcx> TypeFoldable<'tcx> for Instance<'tcx>
impl<'tcx> TypeFoldable<'tcx> for Instance<'tcx>
sourcefn try_fold_with<__F: FallibleTypeFolder<'tcx>>(
self,
__folder: &mut __F
) -> Result<Self, __F::Error>
fn try_fold_with<__F: FallibleTypeFolder<'tcx>>(
self,
__folder: &mut __F
) -> Result<Self, __F::Error>
sourcefn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self
fn fold_with<F: TypeFolder<'tcx>>(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
. Read moresourceimpl<'tcx> TypeVisitable<'tcx> for Instance<'tcx>
impl<'tcx> TypeVisitable<'tcx> for Instance<'tcx>
sourcefn visit_with<__V: TypeVisitor<'tcx>>(
&self,
__visitor: &mut __V
) -> ControlFlow<__V::BreakTy>
fn visit_with<__V: TypeVisitor<'tcx>>(
&self,
__visitor: &mut __V
) -> ControlFlow<__V::BreakTy>
sourcefn 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. Read moresourcefn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
true
if this self
has any regions that escape binder
(and
hence are not bound by it). Read morefn has_escaping_bound_vars(&self) -> bool
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) -> Option<ErrorGuaranteed>
fn has_param_types_or_consts(&self) -> bool
fn has_infer_regions(&self) -> bool
fn has_infer_types(&self) -> bool
fn has_infer_types_or_consts(&self) -> bool
fn needs_infer(&self) -> bool
fn has_placeholders(&self) -> bool
fn needs_subst(&self) -> bool
sourcefn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
sourcefn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
sourcefn is_global(&self) -> bool
fn is_global(&self) -> bool
sourcefn has_late_bound_regions(&self) -> bool
fn has_late_bound_regions(&self) -> bool
sourcefn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization. Read moreimpl<'tcx> Copy for Instance<'tcx>
impl<'tcx> Eq for Instance<'tcx>
impl<'tcx> StructuralEq for Instance<'tcx>
impl<'tcx> StructuralPartialEq for Instance<'tcx>
Auto Trait Implementations
impl<'tcx> !RefUnwindSafe for Instance<'tcx>
impl<'tcx> Send for Instance<'tcx>
impl<'tcx> Sync for Instance<'tcx>
impl<'tcx> Unpin for Instance<'tcx>
impl<'tcx> !UnwindSafe for Instance<'tcx>
Blanket Implementations
sourceimpl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
fn allocate_on(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter(
arena: &'a Arena<'tcx>,
iter: impl IntoIterator<Item = T>
) -> &'a mut [T]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Ctxt, T> DepNodeParams<Ctxt> for Twhere
Ctxt: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
impl<Ctxt, T> DepNodeParams<Ctxt> for Twhere
Ctxt: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
default fn fingerprint_style() -> FingerprintStyle
sourcedefault fn to_fingerprint(&self, tcx: Ctxt) -> Fingerprint
default fn to_fingerprint(&self, tcx: Ctxt) -> Fingerprint
default fn to_debug_str(&self, Ctxt) -> String
sourcedefault fn recover(Ctxt, &DepNode<<Ctxt as DepContext>::DepKind>) -> Option<T>
default fn recover(Ctxt, &DepNode<<Ctxt as DepContext>::DepKind>) -> Option<T>
DepNode
,
something which is needed when forcing DepNode
s during red-green
evaluation. The query system will only call this method if
fingerprint_style()
is not FingerprintStyle::Opaque
.
It is always valid to return None
here, in which case incremental
compilation will treat the query as having changed instead of forcing it. Read moresourceimpl<T, R> InternIteratorElement<T, R> for T
impl<T, R> InternIteratorElement<T, R> for T
type Output = R
fn intern_with<I, F>(iter: I, f: F) -> <T as InternIteratorElement<T, R>>::Outputwhere
I: Iterator<Item = T>,
F: FnOnce(&[T]) -> R,
sourceimpl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
sourceimpl<CTX, T> Value<CTX> for Twhere
CTX: DepContext,
impl<CTX, T> Value<CTX> for Twhere
CTX: DepContext,
default fn from_cycle_error(tcx: CTX) -> T
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
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: 32 bytes