nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-04-28 19:17:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #80166 - pierwill:pierwill-rustcmiddle-place, r=petrochenkov

Browse Source 
Edit rustc_middle docs

Re-word doc comment for rustc_middle::hir::place::Projection.

Also adds:

- Missing end stop punctuation, and
- Documentation links to `rustc_middle::mir::Place`.
This commit is contained in:
Dylan DPC 2020-12-21 02:47:37 +01:00 committed by GitHub
commit 251d435e2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
compiler/rustc_middle/src/hir/place.rs
View File

@ -17,13 +17,13 @@ use rustc_target::abi::VariantIdx;
HashStable HashStable
)] )]
pub enum PlaceBase { pub enum PlaceBase {
/// A temporary variable /// A temporary variable.
Rvalue, Rvalue,
/// A named `static` item /// A named `static` item.
StaticItem, StaticItem,
/// A named local variable /// A named local variable.
Local(HirId), Local(HirId),
/// An upvar referenced by closure env /// An upvar referenced by closure env.
Upvar(ty::UpvarId), Upvar(ty::UpvarId),
} }
@ -40,7 +40,7 @@ pub enum PlaceBase {
HashStable HashStable
)] )]
pub enum ProjectionKind { pub enum ProjectionKind {
/// A dereference of a pointer, reference or `Box<T>` of the given type /// A dereference of a pointer, reference or `Box<T>` of the given type.
Deref, Deref,
/// `B.F` where `B` is the base expression and `F` is /// `B.F` where `B` is the base expression and `F` is
@ -71,16 +71,16 @@ pub enum ProjectionKind {
HashStable HashStable
)] )]
pub struct Projection<'tcx> { pub struct Projection<'tcx> {
/// Type after the projection is being applied. /// Type after the projection is applied.
pub ty: Ty<'tcx>, pub ty: Ty<'tcx>,
/// Defines the type of access /// Defines the kind of access made by the projection.
pub kind: ProjectionKind, pub kind: ProjectionKind,
} }
/// A `Place` represents how a value is located in memory. /// A `Place` represents how a value is located in memory.
/// ///
/// This is an HIR version of `mir::Place` /// This is an HIR version of [`rustc_middle::mir::Place`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable, TypeFoldable, HashStable)] #[derive(Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable, TypeFoldable, HashStable)]
pub struct Place<'tcx> { pub struct Place<'tcx> {
/// The type of the `PlaceBase` /// The type of the `PlaceBase`
@ -93,13 +93,13 @@ pub struct Place<'tcx> {
/// A `PlaceWithHirId` represents how a value is located in memory. /// A `PlaceWithHirId` represents how a value is located in memory.
/// ///
/// This is an HIR version of `mir::Place` /// This is an HIR version of [`rustc_middle::mir::Place`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable, TypeFoldable, HashStable)] #[derive(Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable, TypeFoldable, HashStable)]
pub struct PlaceWithHirId<'tcx> { pub struct PlaceWithHirId<'tcx> {
/// `HirId` of the expression or pattern producing this value. /// `HirId` of the expression or pattern producing this value.
pub hir_id: HirId, pub hir_id: HirId,
/// Information about the `Place` /// Information about the `Place`.
pub place: Place<'tcx>, pub place: Place<'tcx>,
} }