Skip to content

Commit cdf8fcf

Browse files
frank-kingfrank-king
committed
parse pinned local variable declarations
1 parent ecda83b commit cdf8fcf

File tree

49 files changed

+390
-85
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+390
-85
lines changed

‎compiler/rustc_ast/src/ast.rs

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -718,18 +718,22 @@ impl ByRef {
718718
/// Used for both the explicit binding annotations given in the HIR for a binding
719719
/// and the final binding mode that we infer after type inference/match ergonomics.
720720
/// `.0` is the by-reference mode (`ref`, `ref mut`, or by value),
721-
/// `.1` is the mutability of the binding.
721+
/// `.1` is the pinnedness of the binding,
722+
/// `.2` is the mutability of the binding.
722723
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
723724
#[derive(Encodable, Decodable, HashStable_Generic)]
724-
pub struct BindingMode(pub ByRef, pub Mutability);
725+
pub struct BindingMode(pub ByRef, pub Pinnedness, pub Mutability);
725726

726727
impl BindingMode {
727-
pub const NONE: Self = Self(ByRef::No, Mutability::Not);
728-
pub const REF: Self = Self(ByRef::Yes(Mutability::Not), Mutability::Not);
729-
pub const MUT: Self = Self(ByRef::No, Mutability::Mut);
730-
pub const REF_MUT: Self = Self(ByRef::Yes(Mutability::Mut), Mutability::Not);
731-
pub const MUT_REF: Self = Self(ByRef::Yes(Mutability::Not), Mutability::Mut);
732-
pub const MUT_REF_MUT: Self = Self(ByRef::Yes(Mutability::Mut), Mutability::Mut);
728+
pub const NONE: Self = Self(ByRef::No, Pinnedness::Not, Mutability::Not);
729+
pub const REF: Self = Self(ByRef::Yes(Mutability::Not), Pinnedness::Not, Mutability::Not);
730+
pub const MUT: Self = Self(ByRef::No, Pinnedness::Not, Mutability::Mut);
731+
pub const REF_MUT: Self = Self(ByRef::Yes(Mutability::Mut), Pinnedness::Not, Mutability::Not);
732+
pub const MUT_REF: Self = Self(ByRef::Yes(Mutability::Not), Pinnedness::Not, Mutability::Mut);
733+
pub const MUT_REF_MUT: Self =
734+
Self(ByRef::Yes(Mutability::Mut), Pinnedness::Not, Mutability::Mut);
735+
pub const PIN_CONST: Self = Self(ByRef::No, Pinnedness::Pinned, Mutability::Not);
736+
pub const PIN_MUT: Self = Self(ByRef::No, Pinnedness::Pinned, Mutability::Mut);
733737

734738
pub fn prefix_str(self) -> &'static str {
735739
match self {
@@ -739,6 +743,9 @@ impl BindingMode {
739743
Self::REF_MUT => "ref mut ",
740744
Self::MUT_REF => "mut ref ",
741745
Self::MUT_REF_MUT => "mut ref mut ",
746+
Self::PIN_CONST => "pin const ",
747+
Self::PIN_MUT => "pin mut ",
748+
Self(_, Pinnedness::Pinned, _) => panic!("unsupported pinned binding mode"),
742749
}
743750
}
744751
}
@@ -2551,7 +2558,9 @@ pub type ExplicitSelf = Spanned<SelfKind>;
25512558
impl Param {
25522559
/// Attempts to cast parameter to `ExplicitSelf`.
25532560
pub fn to_self(&self) -> Option<ExplicitSelf> {
2554-
if let PatKind::Ident(BindingMode(ByRef::No, mutbl), ident, _) = self.pat.kind {
2561+
if let PatKind::Ident(BindingMode(ByRef::No, Pinnedness::Not, mutbl), ident, _) =
2562+
self.pat.kind
2563+
{
25552564
if ident.name == kw::SelfLower {
25562565
return match self.ty.kind {
25572566
TyKind::ImplicitSelf => Some(respan(self.pat.span, SelfKind::Value(mutbl))),
@@ -2606,7 +2615,11 @@ impl Param {
26062615
attrs,
26072616
pat: P(Pat {
26082617
id: DUMMY_NODE_ID,
2609-
kind: PatKind::Ident(BindingMode(ByRef::No, mutbl), eself_ident, None),
2618+
kind: PatKind::Ident(
2619+
BindingMode(ByRef::No, Pinnedness::Not, mutbl),
2620+
eself_ident,
2621+
None,
2622+
),
26102623
span,
26112624
tokens: None,
26122625
}),

‎compiler/rustc_ast_ir/src/lib.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,12 @@ pub enum Pinnedness {
8686
Not,
8787
Pinned,
8888
}
89+
90+
impl Pinnedness {
91+
pub fn is_pin(self) -> bool {
92+
matches!(self, Self::Pinned)
93+
}
94+
pub fn is_not(self) -> bool {
95+
matches!(self, Self::Not)
96+
}
97+
}

‎compiler/rustc_ast_lowering/src/item.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1189,7 +1189,9 @@ impl<'hir> LoweringContext<'_, 'hir> {
11891189
// Check if this is a binding pattern, if so, we can optimize and avoid adding a
11901190
// `let <pat> = __argN;` statement. In this case, we do not rename the parameter.
11911191
let (ident, is_simple_parameter) = match parameter.pat.kind {
1192-
hir::PatKind::Binding(hir::BindingMode(ByRef::No, _), _, ident, _) => (ident, true),
1192+
hir::PatKind::Binding(hir::BindingMode(ByRef::No, _, _), _, ident, _) => {
1193+
(ident, true)
1194+
}
11931195
// For `ref mut` or wildcard arguments, we can't reuse the binding, but
11941196
// we can keep the same name for the parameter.
11951197
// This lets rustdoc render it correctly in documentation.

‎compiler/rustc_ast_lowering/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1607,7 +1607,7 @@ impl<'a, 'hir> LoweringContext<'a, 'hir> {
16071607
implicit_self: decl.inputs.get(0).map_or(hir::ImplicitSelfKind::None, |arg| {
16081608
let is_mutable_pat = matches!(
16091609
arg.pat.kind,
1610-
PatKind::Ident(hir::BindingMode(_, Mutability::Mut), ..)
1610+
PatKind::Ident(hir::BindingMode(_, _, Mutability::Mut), ..)
16111611
);
16121612

16131613
match &arg.ty.kind {

‎compiler/rustc_ast_pretty/src/pprust/state.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1594,7 +1594,10 @@ impl<'a> State<'a> {
15941594
match &pat.kind {
15951595
PatKind::Wild => self.word("_"),
15961596
PatKind::Never => self.word("!"),
1597-
PatKind::Ident(BindingMode(by_ref, mutbl), ident, sub) => {
1597+
PatKind::Ident(BindingMode(by_ref, pin, mutbl), ident, sub) => {
1598+
if pin.is_pin() {
1599+
self.word_nbsp("pin");
1600+
}
15981601
if mutbl.is_mut() {
15991602
self.word_nbsp("mut");
16001603
}

‎compiler/rustc_borrowck/src/diagnostics/mutability_errors.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ impl<'infcx, 'tcx> MirBorrowckCtxt<'_, 'infcx, 'tcx> {
304304
{
305305
match *decl.local_info() {
306306
LocalInfo::User(BindingForm::Var(mir::VarBindingForm {
307-
binding_mode: BindingMode(ByRef::No, Mutability::Not),
307+
binding_mode: BindingMode(ByRef::No, _, Mutability::Not),
308308
opt_ty_info: Some(sp),
309309
opt_match_place: _,
310310
pat_span: _,
@@ -732,7 +732,7 @@ impl<'infcx, 'tcx> MirBorrowckCtxt<'_, 'infcx, 'tcx> {
732732
debug!("local_decl: {:?}", local_decl);
733733
let pat_span = match *local_decl.local_info() {
734734
LocalInfo::User(BindingForm::Var(mir::VarBindingForm {
735-
binding_mode: BindingMode(ByRef::No, Mutability::Not),
735+
binding_mode: BindingMode(ByRef::No, _, Mutability::Not),
736736
opt_ty_info: _,
737737
opt_match_place: _,
738738
pat_span,
@@ -1147,7 +1147,7 @@ impl<'infcx, 'tcx> MirBorrowckCtxt<'_, 'infcx, 'tcx> {
11471147
}
11481148

11491149
LocalInfo::User(mir::BindingForm::Var(mir::VarBindingForm {
1150-
binding_mode: BindingMode(ByRef::No, _),
1150+
binding_mode: BindingMode(ByRef::No, _, _),
11511151
opt_ty_info,
11521152
..
11531153
})) => {
@@ -1225,7 +1225,7 @@ impl<'infcx, 'tcx> MirBorrowckCtxt<'_, 'infcx, 'tcx> {
12251225
}
12261226

12271227
LocalInfo::User(mir::BindingForm::Var(mir::VarBindingForm {
1228-
binding_mode: BindingMode(ByRef::Yes(_), _),
1228+
binding_mode: BindingMode(ByRef::Yes(_), _, _),
12291229
..
12301230
})) => {
12311231
let pattern_span: Span = local_decl.source_info.span;
@@ -1440,7 +1440,7 @@ fn mut_borrow_of_mutable_ref(local_decl: &LocalDecl<'_>, local_name: Option<Symb
14401440
match *local_decl.local_info() {
14411441
// Check if mutably borrowing a mutable reference.
14421442
LocalInfo::User(mir::BindingForm::Var(mir::VarBindingForm {
1443-
binding_mode: BindingMode(ByRef::No, Mutability::Not),
1443+
binding_mode: BindingMode(ByRef::No, _, Mutability::Not),
14441444
..
14451445
})) => matches!(local_decl.ty.kind(), ty::Ref(_, _, hir::Mutability::Mut)),
14461446
LocalInfo::User(mir::BindingForm::ImplicitSelf(kind)) => {

‎compiler/rustc_builtin_macros/src/deriving/generic/mod.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ pub(crate) use SubstructureFields::*;
183183
use rustc_ast::ptr::P;
184184
use rustc_ast::{
185185
self as ast, AnonConst, BindingMode, ByRef, EnumDef, Expr, GenericArg, GenericParamKind,
186-
Generics, Mutability, PatKind, VariantData,
186+
Generics, Mutability, PatKind, Pinnedness, VariantData,
187187
};
188188
use rustc_attr_parsing as attr;
189189
use rustc_expand::base::{Annotatable, ExtCtxt};
@@ -1477,7 +1477,11 @@ impl<'a> TraitDef<'a> {
14771477
struct_field.ident,
14781478
cx.pat(
14791479
path.span,
1480-
PatKind::Ident(BindingMode(by_ref, Mutability::Not), path, None),
1480+
PatKind::Ident(
1481+
BindingMode(by_ref, Pinnedness::Not, Mutability::Not),
1482+
path,
1483+
None,
1484+
),
14811485
),
14821486
)
14831487
});

‎compiler/rustc_hir/src/pat_util.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ impl hir::Pat<'_> {
9595

9696
pub fn simple_ident(&self) -> Option<Ident> {
9797
match self.kind {
98-
PatKind::Binding(BindingMode(ByRef::No, _), _, ident, None) => Some(ident),
98+
PatKind::Binding(BindingMode(ByRef::No, _, _), _, ident, None) => Some(ident),
9999
_ => None,
100100
}
101101
}

‎compiler/rustc_hir_analysis/src/check/region.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ fn resolve_local<'tcx>(
681681
// & expression, and its lifetime would be extended to the end of the block (due
682682
// to a different rule, not the below code).
683683
match pat.kind {
684-
PatKind::Binding(hir::BindingMode(hir::ByRef::Yes(_), _), ..) => true,
684+
PatKind::Binding(hir::BindingMode(hir::ByRef::Yes(_), _, _), ..) => true,
685685

686686
PatKind::Struct(_, field_pats, _) => field_pats.iter().any(|fp| is_binding_pat(fp.pat)),
687687

@@ -700,7 +700,7 @@ fn resolve_local<'tcx>(
700700
}
701701

702702
PatKind::Ref(_, _)
703-
| PatKind::Binding(hir::BindingMode(hir::ByRef::No, _), ..)
703+
| PatKind::Binding(hir::BindingMode(hir::ByRef::No, _, _), ..)
704704
| PatKind::Wild
705705
| PatKind::Never
706706
| PatKind::Path(_)

‎compiler/rustc_hir_pretty/src/lib.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1871,7 +1871,10 @@ impl<'a> State<'a> {
18711871
match pat.kind {
18721872
PatKind::Wild => self.word("_"),
18731873
PatKind::Never => self.word("!"),
1874-
PatKind::Binding(BindingMode(by_ref, mutbl), _, ident, sub) => {
1874+
PatKind::Binding(BindingMode(by_ref, pin, mutbl), _, ident, sub) => {
1875+
if pin.is_pin() {
1876+
self.word_nbsp("pin");
1877+
}
18751878
if mutbl.is_mut() {
18761879
self.word_nbsp("mut");
18771880
}

0 commit comments

Comments
 (0)