Enum rustc_middle::ty::instance::InstanceDef
source · pub enum InstanceDef<'tcx> {
Item(WithOptConstParam<DefId>),
Intrinsic(DefId),
VTableShim(DefId),
ReifyShim(DefId),
FnPtrShim(DefId, Ty<'tcx>),
Virtual(DefId, usize),
ClosureOnceShim {
call_once: DefId,
track_caller: bool,
},
DropGlue(DefId, Option<Ty<'tcx>>),
CloneShim(DefId, Ty<'tcx>),
}
Variants
Item(WithOptConstParam<DefId>)
A user-defined callable item.
This includes:
fn
items- closures
- generators
Intrinsic(DefId)
An intrinsic fn
item (with "rust-intrinsic"
or "platform-intrinsic"
ABI).
Alongside Virtual
, this is the only InstanceDef
that does not have its own callable MIR.
Instead, codegen and const eval “magically” evaluate calls to intrinsics purely in the
caller.
VTableShim(DefId)
<T as Trait>::method
where method
receives unsizeable self: Self
(part of the
unsized_locals
feature).
The generated shim will take Self
via *mut Self
- conceptually this is &owned Self
-
and dereference the argument to call the original function.
ReifyShim(DefId)
fn()
pointer where the function itself cannot be turned into a pointer.
One example is <dyn Trait as Trait>::fn
, where the shim contains
a virtual call, which codegen supports only via a direct call to the
<dyn Trait as Trait>::fn
instance (an InstanceDef::Virtual
).
Another example is functions annotated with #[track_caller]
, which
must have their implicit caller location argument populated for a call.
Because this is a required part of the function’s ABI but can’t be tracked
as a property of the function pointer, we use a single “caller location”
(the definition of the function itself).
FnPtrShim(DefId, Ty<'tcx>)
<fn() as FnTrait>::call_*
(generated FnTrait
implementation for fn()
pointers).
DefId
is FnTrait::call_*
.
Virtual(DefId, usize)
Dynamic dispatch to <dyn Trait as Trait>::fn
.
This InstanceDef
does not have callable MIR. Calls to Virtual
instances must be
codegen’d as virtual calls through the vtable.
If this is reified to a fn
pointer, a ReifyShim
is used (see ReifyShim
above for more
details on that).
ClosureOnceShim
<[FnMut closure] as FnOnce>::call_once
.
The DefId
is the ID of the call_once
method in FnOnce
.
DropGlue(DefId, Option<Ty<'tcx>>)
core::ptr::drop_in_place::<T>
.
The DefId
is for core::ptr::drop_in_place
.
The Option<Ty<'tcx>>
is either Some(T)
, or None
for empty drop
glue.
CloneShim(DefId, Ty<'tcx>)
Compiler-generated <T as Clone>::clone
implementation.
For all types that automatically implement Copy
, a trivial Clone
impl is provided too.
Additionally, arrays, tuples, and closures get a Clone
shim even if they aren’t Copy
.
The DefId
is for Clone::clone
, the Ty
is the type T
with the builtin Clone
impl.
Implementations
sourceimpl<'tcx> InstanceDef<'tcx>
impl<'tcx> InstanceDef<'tcx>
pub fn def_id(self) -> DefId
sourcepub fn def_id_if_not_guaranteed_local_codegen(self) -> Option<DefId>
pub fn def_id_if_not_guaranteed_local_codegen(self) -> Option<DefId>
Returns the DefId
of instances which might not require codegen locally.
pub fn with_opt_param(self) -> WithOptConstParam<DefId>
pub fn get_attrs(&self, tcx: TyCtxt<'tcx>, attr: Symbol) -> Attributes<'tcx>
sourcepub fn requires_inline(&self, tcx: TyCtxt<'tcx>) -> bool
pub fn requires_inline(&self, tcx: TyCtxt<'tcx>) -> bool
Returns true
if the LLVM version of this instance is unconditionally
marked with inline
. This implies that a copy of this instance is
generated in every codegen unit.
Note that this is only a hint. See the documentation for
generates_cgu_internal_copy
for more information.
sourcepub fn generates_cgu_internal_copy(&self, tcx: TyCtxt<'tcx>) -> bool
pub fn generates_cgu_internal_copy(&self, tcx: TyCtxt<'tcx>) -> bool
Returns true
if the machine code for this instance is instantiated in
each codegen unit that references it.
Note that this is only a hint! The compiler can globally decide to not
do this in order to speed up compilation. CGU-internal copies are
only exist to enable inlining. If inlining is not performed (e.g. at
-Copt-level=0
) then the time for generating them is wasted and it’s
better to create a single copy with external linkage.
pub fn requires_caller_location(&self, tcx: TyCtxt<'_>) -> bool
sourcepub fn has_polymorphic_mir_body(&self) -> bool
pub fn has_polymorphic_mir_body(&self) -> bool
Returns true
when the MIR body associated with this instance should be monomorphized
by its users (e.g. codegen or miri) by substituting the substs
from Instance
(see
Instance::substs_for_mir_body
).
Otherwise, returns false
only for some kinds of shims where the construction of the MIR
body should perform necessary substitutions.
Trait Implementations
sourceimpl<'tcx> Clone for InstanceDef<'tcx>
impl<'tcx> Clone for InstanceDef<'tcx>
sourcefn clone(&self) -> InstanceDef<'tcx>
fn clone(&self) -> InstanceDef<'tcx>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'tcx> Debug for InstanceDef<'tcx>
impl<'tcx> Debug for InstanceDef<'tcx>
sourceimpl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for InstanceDef<'tcx>
impl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for InstanceDef<'tcx>
sourceimpl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for InstanceDef<'tcx>
impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for InstanceDef<'tcx>
sourceimpl<'tcx> Hash for InstanceDef<'tcx>
impl<'tcx> Hash for InstanceDef<'tcx>
sourceimpl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for InstanceDef<'tcx>
impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for InstanceDef<'tcx>
fn hash_stable(
&self,
__hcx: &mut StableHashingContext<'__ctx>,
__hasher: &mut StableHasher
)
sourceimpl<'tcx, '__lifted> Lift<'__lifted> for InstanceDef<'tcx>
impl<'tcx, '__lifted> Lift<'__lifted> for InstanceDef<'tcx>
type Lifted = InstanceDef<'__lifted>
fn lift_to_tcx(self, __tcx: TyCtxt<'__lifted>) -> Option<InstanceDef<'__lifted>>
sourceimpl<'tcx> Ord for InstanceDef<'tcx>
impl<'tcx> Ord for InstanceDef<'tcx>
sourcefn cmp(&self, other: &InstanceDef<'tcx>) -> Ordering
fn cmp(&self, other: &InstanceDef<'tcx>) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl<'tcx> PartialEq<InstanceDef<'tcx>> for InstanceDef<'tcx>
impl<'tcx> PartialEq<InstanceDef<'tcx>> for InstanceDef<'tcx>
sourcefn eq(&self, other: &InstanceDef<'tcx>) -> bool
fn eq(&self, other: &InstanceDef<'tcx>) -> bool
sourceimpl<'tcx> PartialOrd<InstanceDef<'tcx>> for InstanceDef<'tcx>
impl<'tcx> PartialOrd<InstanceDef<'tcx>> for InstanceDef<'tcx>
sourcefn partial_cmp(&self, other: &InstanceDef<'tcx>) -> Option<Ordering>
fn partial_cmp(&self, other: &InstanceDef<'tcx>) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl<'tcx> TypeFoldable<'tcx> for InstanceDef<'tcx>
impl<'tcx> TypeFoldable<'tcx> for InstanceDef<'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 InstanceDef<'tcx>
impl<'tcx> TypeVisitable<'tcx> for InstanceDef<'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 InstanceDef<'tcx>
impl<'tcx> Eq for InstanceDef<'tcx>
impl<'tcx> StructuralEq for InstanceDef<'tcx>
impl<'tcx> StructuralPartialEq for InstanceDef<'tcx>
Auto Trait Implementations
impl<'tcx> !RefUnwindSafe for InstanceDef<'tcx>
impl<'tcx> Send for InstanceDef<'tcx>
impl<'tcx> Sync for InstanceDef<'tcx>
impl<'tcx> Unpin for InstanceDef<'tcx>
impl<'tcx> !UnwindSafe for InstanceDef<'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: 24 bytes
Size for each variant:
Item
: 19 bytesIntrinsic
: 11 bytesVTableShim
: 11 bytesReifyShim
: 11 bytesFnPtrShim
: 23 bytesVirtual
: 23 bytesClosureOnceShim
: 11 bytesDropGlue
: 23 bytesCloneShim
: 23 bytes