Enum rustc_middle::mir::Operand
source · [−]Expand description
An operand in MIR represents a “value” in Rust, the definition of which is undecided and part of the memory model. One proposal for a definition of values can be found on UCG.
The most common way to create values is via loading a place. Loading a place is an operation which reads the memory of the place and converts it to a value. This is a fundamentally typed operation. The nature of the value produced depends on the type of the conversion. Furthermore, there may be other effects: if the type has a validity constraint loading the place might be UB if the validity constraint is not met.
Needs clarification: Ralf proposes that loading a place not have side-effects. This is what is implemented in miri today. Are these the semantics we want for MIR? Is this something we can even decide without knowing more about Rust’s memory model?
Needs clarifiation: Is loading a place that has its variant index set well-formed? Miri currently implements it, but it seems like this may be something to check against in the validator.
Variants
Copy(Place<'tcx>)
Creates a value by loading the given place.
Before drop elaboration, the type of the place must be Copy
. After drop elaboration there
is no such requirement.
Move(Place<'tcx>)
Creates a value by performing loading the place, just like the Copy
operand.
This may additionally overwrite the place with uninit
bytes, depending on how we decide
in UCG#188. You should not emit MIR that may attempt a subsequent second load of this
place without first re-initializing it.
Constant(Box<Constant<'tcx>>)
Constants are already semantically values, and remain unchanged.
Implementations
sourceimpl<'tcx> Operand<'tcx>
impl<'tcx> Operand<'tcx>
sourcepub fn function_handle(
tcx: TyCtxt<'tcx>,
def_id: DefId,
substs: SubstsRef<'tcx>,
span: Span
) -> Self
pub fn function_handle(
tcx: TyCtxt<'tcx>,
def_id: DefId,
substs: SubstsRef<'tcx>,
span: Span
) -> Self
Convenience helper to make a constant that refers to the fn
with given DefId
and substs. Since this is used to synthesize
MIR, assumes user_ty
is None.
pub fn is_move(&self) -> bool
sourcepub fn const_from_scalar(
tcx: TyCtxt<'tcx>,
ty: Ty<'tcx>,
val: Scalar,
span: Span
) -> Operand<'tcx>
pub fn const_from_scalar(
tcx: TyCtxt<'tcx>,
ty: Ty<'tcx>,
val: Scalar,
span: Span
) -> Operand<'tcx>
Convenience helper to make a literal-like constant from a given scalar value.
Since this is used to synthesize MIR, assumes user_ty
is None.
pub fn to_copy(&self) -> Self
sourcepub fn place(&self) -> Option<Place<'tcx>>
pub fn place(&self) -> Option<Place<'tcx>>
Returns the Place
that is the target of this Operand
, or None
if this Operand
is a
constant.
sourcepub fn constant(&self) -> Option<&Constant<'tcx>>
pub fn constant(&self) -> Option<&Constant<'tcx>>
Returns the Constant
that is the target of this Operand
, or None
if this Operand
is a
place.
sourcepub fn const_fn_def(&self) -> Option<(DefId, SubstsRef<'tcx>)>
pub fn const_fn_def(&self) -> Option<(DefId, SubstsRef<'tcx>)>
Gets the ty::FnDef
from an operand if it’s a constant function item.
While this is unlikely in general, it’s the normal case of what you’ll
find as the func
in a TerminatorKind::Call
.
Trait Implementations
sourceimpl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Operand<'tcx>
impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Operand<'tcx>
fn hash_stable(
&self,
__hcx: &mut StableHashingContext<'__ctx>,
__hasher: &mut StableHasher
)
sourceimpl<'tcx> TypeFoldable<'tcx> for Operand<'tcx>
impl<'tcx> TypeFoldable<'tcx> for Operand<'tcx>
sourcefn try_super_fold_with<F: FallibleTypeFolder<'tcx>>(
self,
folder: &mut F
) -> Result<Self, F::Error>
fn try_super_fold_with<F: FallibleTypeFolder<'tcx>>(
self,
folder: &mut F
) -> Result<Self, F::Error>
Traverses the type in question, typically by calling try_fold_with
on
each field/element. This is true even for types of interest such as
Ty
. This should only be called within TypeFolder
methods, when
non-custom traversals are desired for types of interest. Read more
sourcefn super_visit_with<V: TypeVisitor<'tcx>>(
&self,
visitor: &mut V
) -> ControlFlow<V::BreakTy>
fn super_visit_with<V: TypeVisitor<'tcx>>(
&self,
visitor: &mut V
) -> ControlFlow<V::BreakTy>
Traverses the type in question, typically by calling visit_with
on
each field/element. This is true even for types of interest such as
Ty
. This should only be called within TypeVisitor
methods, when
non-custom traversals are desired for types of interest. Read more
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>
The main entry point for folding. To fold a value t
with a folder f
call: t.try_fold_with(f)
. Read more
sourcefn fold_with<F: TypeFolder<'tcx, Error = !>>(self, folder: &mut F) -> Self
fn fold_with<F: TypeFolder<'tcx, Error = !>>(self, folder: &mut F) -> Self
A convenient alternative to try_fold_with
for use with infallible
folders. Do not override this method, to ensure coherence with
try_fold_with
. Read more
sourcefn super_fold_with<F: TypeFolder<'tcx, Error = !>>(self, folder: &mut F) -> Self
fn super_fold_with<F: TypeFolder<'tcx, Error = !>>(self, folder: &mut F) -> Self
A convenient alternative to try_super_fold_with
for use with
infallible folders. Do not override this method, to ensure coherence
with try_super_fold_with
. Read more
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>
The entry point for visiting. To visit a value t
with a visitor v
call: t.visit_with(v)
. Read more
sourcefn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
Returns 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 more
sourcefn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
Returns true
if this self
has any regions that escape binder
(and
hence are not bound by it). Read more
fn 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
“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound. Read more
fn has_erased_regions(&self) -> bool
sourcefn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
True if there are any un-erased free regions.
sourcefn is_global(&self) -> bool
fn is_global(&self) -> bool
Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching. Read more
sourcefn has_late_bound_regions(&self) -> bool
fn has_late_bound_regions(&self) -> bool
True if there are any late-bound regions
sourcefn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
Indicates whether this value still has parameters/placeholders/inference variables
which could be replaced later, in a way that would change the results of impl
specialization. Read more
impl<'tcx> StructuralPartialEq for Operand<'tcx>
Auto Trait Implementations
impl<'tcx> !RefUnwindSafe for Operand<'tcx>
impl<'tcx> !Send for Operand<'tcx>
impl<'tcx> !Sync for Operand<'tcx>
impl<'tcx> Unpin for Operand<'tcx>
impl<'tcx> !UnwindSafe for Operand<'tcx>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Ctxt, T> DepNodeParams<Ctxt> for T where
Ctxt: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
impl<Ctxt, T> DepNodeParams<Ctxt> for T where
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
This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous). Read more
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>
This method tries to recover the query key from the given 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 more
sourceimpl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<'a, T> Captures<'a> for T where
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:
Copy
: 16 bytesMove
: 16 bytesConstant
: 8 bytes