Auto merge of #125397 - gurry:125303-wrong-builder-suggestion, r=compiler-errors

Do not suggest unresolvable builder methods

Fixes #125303

The issue was that when a builder method cannot be resolved we are suggesting alternatives that themselves cannot be resolved. This PR adds a check that filters them from the list of suggestions.
This commit is contained in:
bors 2024-06-03 03:16:35 +00:00
commit 865eaf96be
10 changed files with 141 additions and 26 deletions

View file

@ -1347,6 +1347,7 @@ fn check_method_call(
Some(rcvr), Some(rcvr),
rcvr_t, rcvr_t,
segment.ident, segment.ident,
expr.hir_id,
SelfSource::MethodCall(rcvr), SelfSource::MethodCall(rcvr),
error, error,
Some(args), Some(args),

View file

@ -832,6 +832,7 @@ pub fn resolve_ty_and_res_fully_qualified_call(
None, None,
ty.normalized, ty.normalized,
item_name, item_name,
hir_id,
SelfSource::QPath(qself), SelfSource::QPath(qself),
error, error,
args, args,

View file

@ -191,6 +191,7 @@ pub fn report_method_error(
rcvr_opt: Option<&'tcx hir::Expr<'tcx>>, rcvr_opt: Option<&'tcx hir::Expr<'tcx>>,
rcvr_ty: Ty<'tcx>, rcvr_ty: Ty<'tcx>,
item_name: Ident, item_name: Ident,
expr_id: hir::HirId,
source: SelfSource<'tcx>, source: SelfSource<'tcx>,
error: MethodError<'tcx>, error: MethodError<'tcx>,
args: Option<&'tcx [hir::Expr<'tcx>]>, args: Option<&'tcx [hir::Expr<'tcx>]>,
@ -216,6 +217,7 @@ pub fn report_method_error(
rcvr_opt, rcvr_opt,
rcvr_ty, rcvr_ty,
item_name, item_name,
expr_id,
source, source,
args, args,
sugg_span, sugg_span,
@ -549,6 +551,7 @@ pub fn report_no_match_method_error(
rcvr_opt: Option<&'tcx hir::Expr<'tcx>>, rcvr_opt: Option<&'tcx hir::Expr<'tcx>>,
rcvr_ty: Ty<'tcx>, rcvr_ty: Ty<'tcx>,
item_name: Ident, item_name: Ident,
expr_id: hir::HirId,
source: SelfSource<'tcx>, source: SelfSource<'tcx>,
args: Option<&'tcx [hir::Expr<'tcx>]>, args: Option<&'tcx [hir::Expr<'tcx>]>,
sugg_span: Span, sugg_span: Span,
@ -681,7 +684,7 @@ pub fn report_no_match_method_error(
} }
if matches!(source, SelfSource::QPath(_)) && args.is_some() { if matches!(source, SelfSource::QPath(_)) && args.is_some() {
self.find_builder_fn(&mut err, rcvr_ty); self.find_builder_fn(&mut err, rcvr_ty, expr_id);
} }
if tcx.ty_is_opaque_future(rcvr_ty) && item_name.name == sym::poll { if tcx.ty_is_opaque_future(rcvr_ty) && item_name.name == sym::poll {
@ -1942,7 +1945,7 @@ fn note_candidates_on_method_error(
/// Look at all the associated functions without receivers in the type's inherent impls /// Look at all the associated functions without receivers in the type's inherent impls
/// to look for builders that return `Self`, `Option<Self>` or `Result<Self, _>`. /// to look for builders that return `Self`, `Option<Self>` or `Result<Self, _>`.
fn find_builder_fn(&self, err: &mut Diag<'_>, rcvr_ty: Ty<'tcx>) { fn find_builder_fn(&self, err: &mut Diag<'_>, rcvr_ty: Ty<'tcx>, expr_id: hir::HirId) {
let ty::Adt(adt_def, _) = rcvr_ty.kind() else { let ty::Adt(adt_def, _) = rcvr_ty.kind() else {
return; return;
}; };
@ -1951,8 +1954,23 @@ fn find_builder_fn(&self, err: &mut Diag<'_>, rcvr_ty: Ty<'tcx>) {
let mut items = impls let mut items = impls
.iter() .iter()
.flat_map(|i| self.tcx.associated_items(i).in_definition_order()) .flat_map(|i| self.tcx.associated_items(i).in_definition_order())
// Only assoc fn with no receivers. // Only assoc fn with no receivers and only if
.filter(|item| matches!(item.kind, ty::AssocKind::Fn) && !item.fn_has_self_parameter) // they are resolvable
.filter(|item| {
matches!(item.kind, ty::AssocKind::Fn)
&& !item.fn_has_self_parameter
&& self
.probe_for_name(
Mode::Path,
item.ident(self.tcx),
None,
IsSuggestion(true),
rcvr_ty,
expr_id,
ProbeScope::TraitsInScope,
)
.is_ok()
})
.filter_map(|item| { .filter_map(|item| {
// Only assoc fns that return `Self`, `Option<Self>` or `Result<Self, _>`. // Only assoc fns that return `Self`, `Option<Self>` or `Result<Self, _>`.
let ret_ty = self let ret_ty = self

View file

@ -1,5 +0,0 @@
use std::net::TcpStream;
fn main() {
let stream = TcpStream::new(); //~ ERROR no function or associated item named `new` found
}

View file

@ -1,14 +0,0 @@
error[E0599]: no function or associated item named `new` found for struct `TcpStream` in the current scope
--> $DIR/fn-new-doesnt-exist.rs:4:28
|
LL | let stream = TcpStream::new();
| ^^^ function or associated item not found in `TcpStream`
|
note: if you're trying to build a new `TcpStream` consider using one of the following associated functions:
TcpStream::connect
TcpStream::connect_timeout
--> $SRC_DIR/std/src/net/tcp.rs:LL:COL
error: aborting due to 1 previous error
For more information about this error, try `rustc --explain E0599`.

View file

@ -0,0 +1,64 @@
// Tests that we suggest the right alternatives when
// a builder method cannot be resolved
use std::net::TcpStream;
trait SomeTrait {}
struct Foo<T> {
v : T
}
impl<T: SomeTrait + Default> Foo<T> {
// Should not be suggested if constraint on the impl not met
fn new() -> Self {
Self { v: T::default() }
}
}
struct Bar;
impl Bar {
// Should be suggested
fn build() -> Self {
Self {}
}
// Method with self can't be a builder.
// Should not be suggested
fn build_with_self(&self) -> Self {
Self {}
}
}
mod SomeMod {
use Bar;
impl Bar {
// Public method. Should be suggested
pub fn build_public() -> Self {
Self {}
}
// Private method. Should not be suggested
fn build_private() -> Self {
Self {}
}
}
}
fn main() {
// `new` not found on `TcpStream` and `connect` should be suggested
let _stream = TcpStream::new();
//~^ ERROR no function or associated item named `new` found
// Although `new` is found on `<impl Foo<T>>` it should not be
// suggested because `u8` does not meet the `T: SomeTrait` constraint
let _foo = Foo::<u8>::new();
//~^ ERROR the function or associated item `new` exists for struct `Foo<u8>`, but its trait bounds were not satisfied
// Should suggest only `<impl Bar>::build()` and `SomeMod::<impl Bar>::build_public()`.
// Other methods should not suggested because they are private or are not a builder
let _bar = Bar::new();
//~^ ERROR no function or associated item named `new` found
}

View file

@ -0,0 +1,51 @@
error[E0599]: no function or associated item named `new` found for struct `TcpStream` in the current scope
--> $DIR/suggest-builder-fn.rs:52:29
|
LL | let _stream = TcpStream::new();
| ^^^ function or associated item not found in `TcpStream`
|
note: if you're trying to build a new `TcpStream` consider using one of the following associated functions:
TcpStream::connect
TcpStream::connect_timeout
--> $SRC_DIR/std/src/net/tcp.rs:LL:COL
error[E0599]: the function or associated item `new` exists for struct `Foo<u8>`, but its trait bounds were not satisfied
--> $DIR/suggest-builder-fn.rs:57:27
|
LL | struct Foo<T> {
| ------------- function or associated item `new` not found for this struct
...
LL | let _foo = Foo::<u8>::new();
| ^^^ function or associated item cannot be called on `Foo<u8>` due to unsatisfied trait bounds
|
note: trait bound `u8: SomeTrait` was not satisfied
--> $DIR/suggest-builder-fn.rs:12:9
|
LL | impl<T: SomeTrait + Default> Foo<T> {
| ^^^^^^^^^ ------
| |
| unsatisfied trait bound introduced here
error[E0599]: no function or associated item named `new` found for struct `Bar` in the current scope
--> $DIR/suggest-builder-fn.rs:62:21
|
LL | struct Bar;
| ---------- function or associated item `new` not found for this struct
...
LL | let _bar = Bar::new();
| ^^^ function or associated item not found in `Bar`
|
note: if you're trying to build a new `Bar` consider using one of the following associated functions:
Bar::build
SomeMod::<impl Bar>::build_public
--> $DIR/suggest-builder-fn.rs:23:5
|
LL | fn build() -> Self {
| ^^^^^^^^^^^^^^^^^^
...
LL | pub fn build_public() -> Self {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
error: aborting due to 3 previous errors
For more information about this error, try `rustc --explain E0599`.

View file

@ -9,7 +9,7 @@ note: if you're trying to build a new `Vec<_, _>` consider using one of the foll
Vec::<T>::with_capacity Vec::<T>::with_capacity
Vec::<T>::try_with_capacity Vec::<T>::try_with_capacity
Vec::<T>::from_raw_parts Vec::<T>::from_raw_parts
and 6 others and 4 others
--> $SRC_DIR/alloc/src/vec/mod.rs:LL:COL --> $SRC_DIR/alloc/src/vec/mod.rs:LL:COL
help: the function `contains` is implemented on `[_]` help: the function `contains` is implemented on `[_]`
| |

View file

@ -8,7 +8,6 @@ note: if you're trying to build a new `Backtrace` consider using one of the foll
Backtrace::capture Backtrace::capture
Backtrace::force_capture Backtrace::force_capture
Backtrace::disabled Backtrace::disabled
Backtrace::create
--> $SRC_DIR/std/src/backtrace.rs:LL:COL --> $SRC_DIR/std/src/backtrace.rs:LL:COL
help: there is an associated function `force_capture` with a similar name help: there is an associated function `force_capture` with a similar name
| |

View file

@ -9,7 +9,7 @@ note: if you're trying to build a new `Vec<Q>` consider using one of the followi
Vec::<T>::with_capacity Vec::<T>::with_capacity
Vec::<T>::try_with_capacity Vec::<T>::try_with_capacity
Vec::<T>::from_raw_parts Vec::<T>::from_raw_parts
and 6 others and 4 others
--> $SRC_DIR/alloc/src/vec/mod.rs:LL:COL --> $SRC_DIR/alloc/src/vec/mod.rs:LL:COL
help: there is an associated function `new` with a similar name help: there is an associated function `new` with a similar name
| |