Skip to content

Point at private fields in struct literal #98283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4590,6 +4590,7 @@ dependencies = [
name = "rustc_typeck"
version = "0.0.0"
dependencies = [
"itertools",
"rustc_arena",
"rustc_ast",
"rustc_attr",
Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_typeck/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ doctest = false
[dependencies]
rustc_arena = { path = "../rustc_arena" }
tracing = "0.1"
itertools = "0.10.1"
rustc_macros = { path = "../rustc_macros" }
rustc_middle = { path = "../rustc_middle" }
rustc_attr = { path = "../rustc_attr" }
Expand Down
80 changes: 67 additions & 13 deletions compiler/rustc_typeck/src/check/expr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ use crate::type_error_struct;

use super::suggest_call_constructor;
use crate::errors::{AddressOfTemporaryTaken, ReturnStmtOutsideOfFnBody, StructExprNonExhaustive};
use itertools::{Either, Itertools};
use rustc_ast as ast;
use rustc_data_structures::fx::FxHashMap;
use rustc_data_structures::stack::ensure_sufficient_stack;
use rustc_errors::Diagnostic;
use rustc_errors::EmissionGuarantee;
use rustc_errors::ErrorGuaranteed;
use rustc_errors::{pluralize, struct_span_err, Applicability, DiagnosticBuilder, DiagnosticId};
use rustc_errors::{
pluralize, struct_span_err, Applicability, Diagnostic, DiagnosticBuilder, DiagnosticId,
EmissionGuarantee, ErrorGuaranteed, MultiSpan,
};
use rustc_hir as hir;
use rustc_hir::def::{CtorKind, DefKind, Res};
use rustc_hir::def_id::DefId;
Expand Down Expand Up @@ -1672,12 +1673,21 @@ impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
};
self.typeck_results.borrow_mut().fru_field_types_mut().insert(expr_id, fru_tys);
} else if adt_kind != AdtKind::Union && !remaining_fields.is_empty() {
let inaccessible_remaining_fields = remaining_fields.iter().any(|(_, (_, field))| {
!field.vis.is_accessible_from(tcx.parent_module(expr_id).to_def_id(), tcx)
});
debug!(?remaining_fields);
let private_fields: Vec<&ty::FieldDef> = variant
.fields
.iter()
.filter(|field| {
!field.vis.is_accessible_from(tcx.parent_module(expr_id).to_def_id(), tcx)
})
.collect();

if inaccessible_remaining_fields {
self.report_inaccessible_fields(adt_ty, span);
if !private_fields.is_empty()
&& tcx
.visibility(variant.def_id)
.is_accessible_from(tcx.parent_module(expr_id).to_def_id(), tcx)
{
self.report_private_fields(adt_ty, span, private_fields, ast_fields);
} else {
self.report_missing_fields(
adt_ty,
Expand Down Expand Up @@ -1801,21 +1811,65 @@ impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
/// Report an error for a struct field expression when there are invisible fields.
///
/// ```text
/// error: cannot construct `Foo` with struct literal syntax due to inaccessible fields
/// error: cannot construct `Foo` with struct literal syntax due to private fields
/// --> src/main.rs:8:5
/// |
/// 8 | foo::Foo {};
/// | ^^^^^^^^
///
/// error: aborting due to previous error
/// ```
fn report_inaccessible_fields(&self, adt_ty: Ty<'tcx>, span: Span) {
self.tcx.sess.span_err(
fn report_private_fields(
&self,
adt_ty: Ty<'tcx>,
span: Span,
private_fields: Vec<&ty::FieldDef>,
used_fields: &'tcx [hir::ExprField<'tcx>],
) {
let field_names = |fields: Vec<Symbol>, len: usize| match &fields
.iter()
.map(|field| field.to_string())
.collect::<Vec<_>>()[..]
{
_ if len > 6 => String::new(),
[name] => format!("`{name}` "),
[names @ .., last] => {
let names = names.iter().map(|name| format!("`{name}`")).collect::<Vec<_>>();
format!("{} and `{last}` ", names.join(", "))
}
[] => unreachable!(),
};

let mut err = self.tcx.sess.struct_span_err(
span,
&format!(
"cannot construct `{adt_ty}` with struct literal syntax due to inaccessible fields",
"cannot construct `{adt_ty}` with struct literal syntax due to private fields",
),
);
let (used_private_fields, remaining_private_fields): (
Vec<(Symbol, Span)>,
Vec<(Symbol, Span)>,
) = private_fields.iter().partition_map(|field| {
match used_fields.iter().find(|used_field| field.name == used_field.ident.name) {
Some(used_field) => Either::Left((field.name, used_field.span)),
None => Either::Right((field.name, self.tcx.def_span(field.did))),
}
});
let remaining_private_fields_len = remaining_private_fields.len();
err.span_labels(used_private_fields.iter().map(|(_, span)| *span), "private field");
err.span_note(
MultiSpan::from_spans(remaining_private_fields.iter().map(|(_, span)| *span).collect()),
format!(
"missing field{s} {names}{are} private",
s = pluralize!(remaining_private_fields_len),
are = pluralize!("is", remaining_private_fields_len),
names = field_names(
remaining_private_fields.iter().map(|(name, _)| *name).collect(),
remaining_private_fields_len
)
),
);
err.emit();
}

fn report_unknown_field(
Expand Down
2 changes: 1 addition & 1 deletion src/test/ui/issues/issue-76077.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ pub mod foo {

fn main() {
foo::Foo {};
//~^ ERROR cannot construct `Foo` with struct literal syntax due to inaccessible fields
//~^ ERROR cannot construct `Foo` with struct literal syntax due to private fields
}
8 changes: 7 additions & 1 deletion src/test/ui/issues/issue-76077.stderr
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
error: cannot construct `Foo` with struct literal syntax due to inaccessible fields
error: cannot construct `Foo` with struct literal syntax due to private fields
--> $DIR/issue-76077.rs:8:5
|
LL | foo::Foo {};
| ^^^^^^^^
|
note: missing field `you_cant_use_this_field` is private
--> $DIR/issue-76077.rs:3:9
|
LL | you_cant_use_this_field: bool,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: aborting due to previous error

2 changes: 1 addition & 1 deletion src/test/ui/privacy/issue-79593.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ mod foo {

fn correct() {
foo::Pub {};
//~^ ERROR cannot construct `Pub` with struct literal syntax due to inaccessible fields
//~^ ERROR cannot construct `Pub` with struct literal syntax due to private fields
}

fn wrong() {
Expand Down
8 changes: 7 additions & 1 deletion src/test/ui/privacy/issue-79593.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ error[E0063]: missing field `y` in initializer of `Enum`
LL | Enum::Variant { x: () };
| ^^^^^^^^^^^^^ missing `y`

error: cannot construct `Pub` with struct literal syntax due to inaccessible fields
error: cannot construct `Pub` with struct literal syntax due to private fields
--> $DIR/issue-79593.rs:18:5
|
LL | foo::Pub {};
| ^^^^^^^^
|
note: missing field `private` is private
--> $DIR/issue-79593.rs:2:22
|
LL | pub struct Pub { private: () }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, maybe we shouldn't actually point out private fields' definition. It seems like excessive info and showing a private field is kinda against its own purpose...

| ^^^^^^^^^^^

error[E0063]: missing field `y` in initializer of `Enum`
--> $DIR/issue-79593.rs:23:5
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ pub mod foo {

fn main() {
foo::Foo {};
//~^ ERROR cannot construct `Foo` with struct literal syntax due to inaccessible fields
//~^ ERROR cannot construct `Foo` with struct literal syntax due to private fields
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
error: cannot construct `Foo` with struct literal syntax due to inaccessible fields
error: cannot construct `Foo` with struct literal syntax due to private fields
--> $DIR/issue-87872-missing-inaccessible-field-literal.rs:9:5
|
LL | foo::Foo {};
| ^^^^^^^^
|
note: missing field `you_cant_use_this_field` is private
--> $DIR/issue-87872-missing-inaccessible-field-literal.rs:4:9
|
LL | you_cant_use_this_field: bool,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: aborting due to previous error

18 changes: 18 additions & 0 deletions src/test/ui/typeck/missing-private-fields-in-struct-literal.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
pub mod m {
pub struct S {
pub visible: bool,
a: (),
b: (),
c: (),
d: (),
e: (),
}
}

fn main() {
let _ = m::S { //~ ERROR cannot construct `S` with struct literal syntax due to private fields
visible: true,
a: (),
b: (),
};
}
23 changes: 23 additions & 0 deletions src/test/ui/typeck/missing-private-fields-in-struct-literal.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
error: cannot construct `S` with struct literal syntax due to private fields
--> $DIR/missing-private-fields-in-struct-literal.rs:13:13
|
LL | let _ = m::S {
| ^^^^
LL | visible: true,
LL | a: (),
| ----- private field
LL | b: (),
| ----- private field
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just a note with something like "... and other private fields that were not provided" instead of pointing out the actual fields in the struct definition?

|
note: missing fields `c`, `d` and `e` are private
--> $DIR/missing-private-fields-in-struct-literal.rs:6:9
|
LL | c: (),
| ^^^^^
LL | d: (),
| ^^^^^
LL | e: (),
| ^^^^^

error: aborting due to previous error