Enum rustc_middle::mir::Operand

pub enum Operand<'tcx> {
    Copy(Place<'tcx>),
    Move(Place<'tcx>),
    Constant(Box<Constant<'tcx>>),
}

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

impl<'tcx> Operand<'tcx>

pub fn ty<D>(&self, local_decls: &D, tcx: TyCtxt<'tcx>) -> Ty<'tcx> where
    D: HasLocalDecls<'tcx>, 

impl<'tcx> Operand<'tcx>

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

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

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.

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.

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

impl<'tcx> Clone for Operand<'tcx>

fn clone(&self) -> Operand<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for Operand<'tcx>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<'tcx>> Decodable<__D> for Operand<'tcx>

fn decode(__decoder: &mut __D) -> Self

impl<'tcx, __E: TyEncoder<'tcx>> Encodable<__E> for Operand<'tcx>

fn encode(&self, __encoder: &mut __E) -> Result<(), <__E as Encoder>::Error>

impl<'tcx> Hash for Operand<'tcx>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Operand<'tcx>

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx> PartialEq<Operand<'tcx>> for Operand<'tcx>

fn eq(&self, other: &Operand<'tcx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Operand<'tcx>) -> bool

This method tests for !=.

impl<'tcx> TypeFoldable<'tcx> for Operand<'tcx>

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.

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.

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).

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.

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.

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).

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.

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).

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

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.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

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.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

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.

impl<'tcx> StructuralPartialEq for Operand<'tcx>

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 bytes
• Move: 16 bytes
• Constant: 8 bytes