Struct rustc_middle::ty::instance::Instance
source · pub struct Instance<'tcx> {
pub def: InstanceKind<'tcx>,
pub args: GenericArgsRef<'tcx>,
}
Expand description
An InstanceKind
along with the args that are needed to substitute the instance.
Monomorphization happens on-the-fly and no monomorphized MIR is ever created. Instead, this type
simply couples a potentially generic InstanceKind
with some args, and codegen and const eval
will do all required instantiations as they run.
Note: the Lift
impl is currently not used by rustc, but is used by
rustc_codegen_cranelift when the jit
feature is enabled.
Fields§
§def: InstanceKind<'tcx>
§args: GenericArgsRef<'tcx>
Implementations§
source§impl<'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 instantiations 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.
source§impl<'tcx> Instance<'tcx>
impl<'tcx> Instance<'tcx>
pub fn new(def_id: DefId, args: GenericArgsRef<'tcx>) -> Instance<'tcx>
pub fn mono(tcx: TyCtxt<'tcx>, def_id: DefId) -> Instance<'tcx>
pub fn def_id(&self) -> DefId
sourcepub fn try_resolve(
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
def_id: DefId,
args: GenericArgsRef<'tcx>,
) -> Result<Option<Instance<'tcx>>, ErrorGuaranteed>
pub fn try_resolve( tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>, def_id: DefId, args: GenericArgsRef<'tcx>, ) -> Result<Option<Instance<'tcx>>, ErrorGuaranteed>
Resolves a (def_id, args)
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))
, except for when the instance’s inputs hit the type size limit,
in which case it may bail out and return Ok(None)
.
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 expect_resolve( tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>, def_id: DefId, args: GenericArgsRef<'tcx>, span: Span, ) -> Instance<'tcx>
pub fn resolve_for_fn_ptr( tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>, def_id: DefId, args: GenericArgsRef<'tcx>, ) -> Option<Instance<'tcx>>
pub fn expect_resolve_for_vtable( tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>, def_id: DefId, args: GenericArgsRef<'tcx>, span: Span, ) -> Instance<'tcx>
pub fn resolve_closure( tcx: TyCtxt<'tcx>, def_id: DefId, args: GenericArgsRef<'tcx>, requested_kind: ClosureKind, ) -> Instance<'tcx>
pub fn resolve_drop_in_place(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> Instance<'tcx>
pub fn resolve_async_drop_in_place( tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, ) -> Instance<'tcx>
pub fn fn_once_adapter_instance( tcx: TyCtxt<'tcx>, closure_did: DefId, args: GenericArgsRef<'tcx>, ) -> Instance<'tcx>
pub fn try_resolve_item_for_coroutine( tcx: TyCtxt<'tcx>, trait_item_id: DefId, trait_id: DefId, rcvr_args: GenericArgsRef<'tcx>, ) -> Option<Instance<'tcx>>
sourcefn args_for_mir_body(&self) -> Option<GenericArgsRef<'tcx>>
fn args_for_mir_body(&self) -> Option<GenericArgsRef<'tcx>>
Depending on the kind of InstanceKind
, 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 generic parameter array.
In the former case, we want to instantiate those generic types and replace them with the
values from the args when monomorphizing the function body. But in the latter case, we
don’t want to do that instantiation, since it has already been done effectively.
This function returns Some(args)
in the former case and None
otherwise – i.e., if
this function returns None
, then the MIR body does not require instantiation during
codegen.
pub fn instantiate_mir<T>( &self, tcx: TyCtxt<'tcx>, v: EarlyBinder<'tcx, &T>, ) -> T
pub fn instantiate_mir_and_normalize_erasing_regions<T>(
&self,
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
v: EarlyBinder<'tcx, T>,
) -> Twhere
T: TypeFoldable<TyCtxt<'tcx>>,
pub fn try_instantiate_mir_and_normalize_erasing_regions<T>(
&self,
tcx: TyCtxt<'tcx>,
param_env: ParamEnv<'tcx>,
v: EarlyBinder<'tcx, T>,
) -> Result<T, NormalizationError<'tcx>>where
T: TypeFoldable<TyCtxt<'tcx>>,
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.args
are replaced by
identity parameters if they are determined to be unused in instance.def
.
Trait Implementations§
source§impl<'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, )
source§impl<'tcx> Key for Instance<'tcx>
impl<'tcx> Key for Instance<'tcx>
type Cache<V> = DefaultCache<Instance<'tcx>, V>
source§fn default_span(&self, tcx: TyCtxt<'_>) -> Span
fn default_span(&self, tcx: TyCtxt<'_>) -> Span
self
, what span should we use?source§fn key_as_def_id(&self) -> Option<DefId>
fn key_as_def_id(&self) -> Option<DefId>
fn ty_def_id(&self) -> Option<DefId>
source§impl<'tcx> PartialEq for Instance<'tcx>
impl<'tcx> PartialEq for Instance<'tcx>
source§impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Instance<'tcx>
impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Instance<'tcx>
source§fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>(
self,
__folder: &mut __F,
) -> Result<Self, __F::Error>
fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, __folder: &mut __F, ) -> Result<Self, __F::Error>
source§fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
try_fold_with
for use with infallible
folders. Do not override this method, to ensure coherence with
try_fold_with
.source§impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Instance<'tcx>
impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Instance<'tcx>
source§fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>(
&self,
__visitor: &mut __V,
) -> __V::Result
fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V, ) -> __V::Result
impl<'tcx> Copy for Instance<'tcx>
impl<'tcx> Eq for Instance<'tcx>
impl<'tcx> StructuralPartialEq for Instance<'tcx>
Auto Trait Implementations§
impl<'tcx> Freeze for Instance<'tcx>
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§
source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'a mut [T]
source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'a mut [T]
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Tcx, T> DepNodeParams<Tcx> for T
impl<Tcx, T> DepNodeParams<Tcx> for T
default fn fingerprint_style() -> FingerprintStyle
source§default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_debug_str(&self, _: Tcx) -> String
source§default fn recover(_: Tcx, _: &DepNode) -> Option<T>
default fn recover(_: Tcx, _: &DepNode) -> 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.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Filterable for T
impl<T> Filterable for T
source§fn filterable(
self,
filter_name: &'static str,
) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
source§impl<'tcx, T> IsSuggestable<'tcx> for T
impl<'tcx, T> IsSuggestable<'tcx> for T
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
fn has_type_flags(&self, flags: TypeFlags) -> bool
source§fn 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.fn error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>
source§fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
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
fn has_escaping_bound_vars(&self) -> bool
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. Read morefn has_aliases(&self) -> bool
fn has_inherent_projections(&self) -> bool
fn has_opaque_types(&self) -> bool
fn has_coroutines(&self) -> bool
fn references_error(&self) -> bool
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 has_infer(&self) -> bool
fn has_placeholders(&self) -> bool
fn has_non_region_placeholders(&self) -> bool
fn has_param(&self) -> bool
source§fn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
source§fn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
source§fn is_global(&self) -> bool
fn is_global(&self) -> bool
source§fn has_bound_regions(&self) -> bool
fn has_bound_regions(&self) -> bool
source§fn has_non_region_bound_vars(&self) -> bool
fn has_non_region_bound_vars(&self) -> bool
source§fn has_bound_vars(&self) -> bool
fn has_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.source§impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
source§impl<I, T> UpcastFrom<I, T> for T
impl<I, T> UpcastFrom<I, T> for T
fn upcast_from(from: T, _tcx: I) -> T
source§impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeSendSync for T
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