Struct rustc_middle::mir::Place

pub struct Place<'tcx> {
    pub local: Local,
    pub projection: &'tcx List<PlaceElem<'tcx>>,
}

A path to a value; something that can be evaluated without changing or disturbing program state.

Fields

local: Local

projection: &'tcx List<PlaceElem<'tcx>>

projection out of a place (access a field, deref a pointer, etc)

Implementations

impl<'tcx> Place<'tcx>

pub fn ty_from<D>(
    local: Local,
    projection: &[PlaceElem<'tcx>],
    local_decls: &D,
    tcx: TyCtxt<'tcx>
) -> PlaceTy<'tcx> where
    D: HasLocalDecls<'tcx>, 

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

impl<'tcx> Place<'tcx>

pub fn return_place() -> Place<'tcx>

pub fn is_indirect(&self) -> bool

Returns true if this Place contains a Deref projection.

If Place::is_indirect returns false, the caller knows that the Place refers to the same region of memory as its base.

pub fn local_or_deref_local(&self) -> Option<Local>

Finds the innermost Local from this Place, if it is either a local itself or a single deref of a local.

pub fn as_local(&self) -> Option<Local>

If this place represents a local variable like _X with no projections, return Some(_X).

pub fn as_ref(&self) -> PlaceRef<'tcx>

pub fn iter_projections(
    self
) -> impl Iterator<Item = (PlaceRef<'tcx>, PlaceElem<'tcx>)> + DoubleEndedIterator

Iterate over the projections in evaluation order, i.e., the first element is the base with its projection and then subsequently more projections are added. As a concrete example, given the place a.b.c, this would yield:

• (a, .b)
• (a.b, .c)

Given a place without projections, the iterator is empty.

Trait Implementations

impl<'tcx> Clone for Place<'tcx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Place<'_>

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

Formats the value using the given formatter.

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for Place<'tcx>

fn decode(decoder: &mut D) -> Result<Self, D::Error>

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

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

impl From<Local> for Place<'_>

fn from(local: Local) -> Self

Performs the conversion.

impl<'tcx> Hash for Place<'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 Place<'tcx>

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

impl<'tcx> Ord for Place<'tcx>

fn cmp(&self, other: &Place<'tcx>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'tcx> PartialEq<Place<'tcx>> for Place<'tcx>

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

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

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

This method tests for !=.

impl<'tcx> PartialOrd<Place<'tcx>> for Place<'tcx>

fn partial_cmp(&self, other: &Place<'tcx>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'tcx> TypeFoldable<'tcx> for Place<'tcx>

fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

fn super_visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

fn visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

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 definitely_has_type_flags(&self, tcx: TyCtxt<'tcx>, flags: TypeFlags) -> 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 potentially_has_param_types_or_consts(&self) -> bool

fn definitely_has_param_types_or_consts(&self, tcx: TyCtxt<'tcx>) -> 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 potentially_needs_subst(&self) -> bool

fn definitely_needs_subst(&self, tcx: TyCtxt<'tcx>) -> bool

fn has_free_regions(&self, tcx: TyCtxt<'tcx>) -> 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, tcx: TyCtxt<'tcx>) -> bool

True if there are any un-erased free regions.

fn is_known_global(&self) -> bool

Indicates whether this value definitely references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.

fn is_global(&self, tcx: TyCtxt<'tcx>) -> 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> Copy for Place<'tcx>

impl<'tcx> Eq for Place<'tcx>

impl<'tcx> StructuralEq for Place<'tcx>

impl<'tcx> StructuralPartialEq for Place<'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: 16 bytes