Place in rustc_middle::mir - Rust
Description: Places roughly correspond to a “location in memory.” Places in MIR are the same mathematical object as places in Rust. This of course means that what exactly they are is undecided and part of the Rust memory model. However, they will likely contain at least the following pieces of information in some form:

Skip to main content

## Place

# Struct Place

Source

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

Expand description

Places roughly correspond to a “location in memory.” Places in MIR are the same mathematical object as places in Rust. This of course means that what exactly they are is undecided and part of the Rust memory model. However, they will likely contain at least the following pieces of information in some form:

1. The address in memory that the place refers to.
2. The provenance with which the place is being accessed.
3. The type of the place and an optional variant index. See `PlaceTy`.
4. Optionally, some metadata. This exists if and only if the type of the place is not `Sized`.

We’ll give a description below of how all pieces of the place except for the provenance are calculated. We cannot give a description of the provenance, because that is part of the undecided aliasing model - we only include it here at all to acknowledge its existence.

Each local naturally corresponds to the place `Place { local, projection: [] }`. This place has the address of the local’s allocation and the type of the local.

For places that are not locals, ie they have a non-empty list of projections, we define the values as a function of the parent place, that is the place with its last `ProjectionElem` stripped. The way this is computed of course depends on the kind of that last projection element:

- `Downcast`: This projection sets the place’s variant index to the given one, and makes no other changes. A `Downcast` projection must always be followed immediately by a `Field` projection.

- `Field`: `Field` projections take their parent place and create a place referring to one of the fields of the type. The resulting address is the parent address, plus the offset of the field. The type becomes the type of the field. If the parent was unsized and so had metadata associated with it, then the metadata is retained if the field is unsized and thrown out if it is sized.

  These projections are only legal for tuples, ADTs, closures, and coroutines. If the ADT or coroutine has more than one variant, the parent place’s variant index must be set, indicating which variant is being used. If it has just one variant, the variant index may or may not be included - the single possible variant is inferred if it is not included.

- `OpaqueCast`: This projection changes the place’s type to the given one, and makes no other changes. A `OpaqueCast` projection on any type other than an opaque type from the current crate is not well-formed.

- `ConstantIndex`: Computes an offset in units of `T` into the place as described in the documentation for the `ProjectionElem`. The resulting address is the parent’s address plus that offset, and the type is `T`. This is only legal if the parent place has type `[T; N]` or `[T]` (not `&[T]`). Since such a `T` is always sized, any resulting metadata is thrown out.

- `Subslice`: This projection calculates an offset and a new address in a similar manner as `ConstantIndex`. It is also only legal on `[T; N]` and `[T]`. However, this yields a `Place` of type `[T]`, and additionally sets the metadata to be the length of the subslice.

- `Index`: Like `ConstantIndex`, only legal on `[T; N]` or `[T]`. However, `Index` additionally takes a local from which the value of the index is computed at runtime. Computing the value of the index involves interpreting the `Local` as a `Place { local, projection: [] }`, and then computing its value as if done via `Operand::Copy`. The array/slice is then indexed with the resulting value. The local must have type `usize`.

- `Deref`: Derefs are the last type of projection, and the most complicated. They are only legal on parent places that are references, pointers, or `Box`. A `Deref` projection begins by loading a value from the parent place, as if by `Operand::Copy`. It then dereferences the resulting pointer, creating a place of the pointee’s type. The resulting address is the address that was stored in the pointer. If the pointee type is unsized, the pointer additionally stored the value of the metadata.

The “validity invariant” of places is the same as that of raw pointers, meaning that e.g. `*ptr` on a dangling or unaligned pointer is never UB. (Later doing a load/store on that place or turning it into a reference can be UB though!) The only ways for a place computation can cause UB are:

- On a `Deref` projection, we do an actual load of the inner place, with all the usual consequences (the inner place must be based on an aligned pointer, it must point to allocated memory, the aliasig model must allow reads, this must not be a data race).
- For the projections that perform pointer arithmetic, the offset must in-bounds of an allocation (i.e., the preconditions of `ptr::offset` must be met).

## Fields§

§`local: Local`§`projection: &'tcx List<PlaceElem<'tcx>>`

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

## Implementations§

Source§

### impl<'tcx> Place<'tcx>

Source

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

Source

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

Source

#### pub fn is_stable_offset(&self) -> bool

Returns `true` if the `Place` always refers to the same memory region whatever the state of the program.

Source

#### pub fn is_indirect_first_projection(&self) -> bool

Returns `true` if this `Place`’s first projection is `Deref`.

This is useful because for MIR phases `AnalysisPhase::PostCleanup` and later, `Deref` projections can only occur as the first projection. In that case this method is equivalent to `is_indirect`, but faster.

Source

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

Source

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

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

Source

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

Source

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

Source

#### pub fn project_deeper( self, more_projections: &[PlaceElem<'tcx>], tcx: TyCtxt<'tcx>, ) -> Self

Generates a new place by appending `more_projections` to the existing ones and interning the result.

Source

#### pub fn project_to_field( self, idx: FieldIdx, local_decls: &impl HasLocalDecls<'tcx>, tcx: TyCtxt<'tcx>, ) -> Self

Return a place that projects to a field of the current place.

The type of the current place must be an ADT.

Source

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

Source

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

## Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for Place<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

#### fn decode(decoder: &mut D) -> Self

Source§

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

Source§

#### fn encode(&self, __encoder: &mut __E)

Source§

### impl From<Local> for Place<'_>

Source§

#### fn from(local: Local) -> Self

Converts to this type from the input type.
Source§

### impl<'tcx> Hash for Place<'tcx>

Source§

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

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given `Hasher`. Read more
Source§

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

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 (const: unstable) · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl<'tcx> StableHash for Place<'tcx>

Source§

#### fn stable_hash<__Hcx: StableHashCtxt>( &self, __hcx: &mut __Hcx, __hasher: &mut StableHasher, )

Source§

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

Source§

#### fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, __folder: &mut __F, ) -> Result<Self, __F::Error>

The entry point for folding. To fold a value `t` with a folder `f` call: `t.try_fold_with(f)`. Read more
Source§

#### fn fold_with<__F: TypeFolder<TyCtxt<'tcx>>>(self, __folder: &mut __F) -> Self

The entry point for folding. To fold a value `t` with a folder `f` call: `t.fold_with(f)`. Read more
Source§

### impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Place<'tcx>

Source§

#### fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V, ) -> __V::Result

The entry point for visiting. To visit a value `t` with a visitor `v` call: `t.visit_with(v)`. Read more
Source§

### impl<'tcx> Copy for Place<'tcx>

Source§

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

Source§

### impl<'tcx> StructuralPartialEq for Place<'tcx>

## Auto Trait Implementations§

§

### impl<'tcx> DynSend for Place<'tcx>

§

### impl<'tcx> DynSync for Place<'tcx>

§

### impl<'tcx> Freeze for Place<'tcx>

§

### impl<'tcx> !RefUnwindSafe for Place<'tcx>

§

### impl<'tcx> Send for Place<'tcx>

§

### impl<'tcx> Sync for Place<'tcx>

§

### impl<'tcx> Unpin for Place<'tcx>

§

### impl<'tcx> UnsafeUnpin for Place<'tcx>

§

### impl<'tcx> !UnwindSafe for Place<'tcx>

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> AnyEq for T
where T: Any + PartialEq,

Source§

#### fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

#### fn as_any(&self) -> &(dyn Any + 'static)

Source§

### impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where T: Copy,

Source§

#### fn allocate_on(self, arena: &'tcx Arena<'tcx>) -> &'tcx mut T

Source§

#### fn allocate_from_iter( arena: &'tcx Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'tcx mut [T]

Source§

### impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where T: Copy,

Source§

#### fn allocate_on(self, arena: &'tcx Arena<'tcx>) -> &'tcx mut T

Source§

#### fn allocate_from_iter( arena: &'tcx Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'tcx mut [T]

Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<'tcx, T> DepNodeKey<'tcx> for T
where T: StableHash + Debug,

Source§

#### default fn key_fingerprint_style() -> KeyFingerprintStyle

Source§

#### default fn to_fingerprint(&self, tcx: TyCtxt<'tcx>) -> Fingerprint

This method turns a query key into an opaque `Fingerprint` to be used in `DepNode`.
Source§

#### default fn try_recover_key(_: TyCtxt<'tcx>, _: &DepNode) -> 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.
Source§

### impl<T> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `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 more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `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 more
Source§

### impl<K> IntoQueryKey<K> for K

Source§

#### fn into_query_key(self) -> K

Argument conversion from `Self` to `K`. This should always be a very cheap conversion, e.g. `LocalDefId::to_def_id`.
Source§

### impl<'tcx, T> IsSuggestable<'tcx> for T
where T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,

Source§

#### fn is_suggestable(self, tcx: TyCtxt<'tcx>, infer_suggestable: bool) -> bool

Whether this makes sense to suggest in a diagnostic. Read more
Source§

#### fn make_suggestable( self, tcx: TyCtxt<'tcx>, infer_suggestable: bool, placeholder: Option<Ty<'tcx>>, ) -> Option<T>

Source§

### impl<T> MaybeResult<T> for T

Source§

#### type Error = !

Source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

Source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<I, T> TypeVisitableExt<I> for T
where I: Interner, T: TypeVisitable<I>,

Source§

#### fn has_type_flags(&self, flags: TypeFlags) -> bool

Source§

#### 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.
Source§

#### fn error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>

Source§

#### fn non_region_error_reported( &self, ) -> Result<(), <I as Interner>::ErrorGuaranteed>

Source§

#### fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns `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

Returns `true` if this type has regions that are not a part of the type. For example, given a `for<'a> fn(&'a i32)` this function returns `false`, while given a `fn(&'a i32)` it returns `true`. The latter can occur when traversing through the former. Read more
Source§

#### fn has_aliases(&self) -> bool

Source§

#### fn has_opaque_types(&self) -> bool

Source§

#### fn has_coroutines(&self) -> bool

Source§

#### fn references_error(&self) -> bool

Source§

#### fn has_non_region_param(&self) -> bool

Source§

#### fn has_regions(&self) -> bool

Source§

#### fn has_infer_regions(&self) -> bool

Source§

#### fn has_infer_types(&self) -> bool

Source§

#### fn has_non_region_infer(&self) -> bool

Source§

#### fn has_infer(&self) -> bool

Source§

#### fn has_placeholders(&self) -> bool

Source§

#### fn has_non_region_placeholders(&self) -> bool

Source§

#### fn has_param(&self) -> bool

Source§

#### 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.
Source§

#### fn has_erased_regions(&self) -> bool

Source§

#### fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.
Source§

#### 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.
Source§

#### fn has_bound_regions(&self) -> bool

True if there are any late-bound regions
Source§

#### fn has_non_region_bound_vars(&self) -> bool

True if there are any late-bound non-region variables
Source§

#### fn has_bound_vars(&self) -> bool

True if there are any bound variables
Source§

#### 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.
Source§

#### fn has_non_region_error(&self) -> bool

True if a type or const error is reachable
Source§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

### impl<T> ErasedDestructor for T
where T: 'static,

## 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