1 use super::method::probe::{IsSuggestion, Mode, ProbeScope};
2 use super::method::MethodCallee;
3 use super::{Expectation, FnCtxt, TupleArgumentsFlag};
5 use crate::type_error_struct;
6 use rustc_ast::util::parser::PREC_POSTFIX;
7 use rustc_errors::{struct_span_err, Applicability, Diagnostic, StashKey};
9 use rustc_hir::def::{self, Namespace, Res};
10 use rustc_hir::def_id::DefId;
13 traits::{self, Obligation},
16 infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind},
17 traits::ObligationCause,
19 use rustc_middle::ty::adjustment::{
20 Adjust, Adjustment, AllowTwoPhase, AutoBorrow, AutoBorrowMutability,
22 use rustc_middle::ty::SubstsRef;
23 use rustc_middle::ty::{self, Ty, TyCtxt, TypeVisitable};
24 use rustc_span::def_id::LocalDefId;
25 use rustc_span::symbol::{sym, Ident};
27 use rustc_target::spec::abi;
28 use rustc_trait_selection::autoderef::Autoderef;
29 use rustc_trait_selection::infer::InferCtxtExt as _;
30 use rustc_trait_selection::traits::error_reporting::DefIdOrName;
31 use rustc_trait_selection::traits::query::evaluate_obligation::InferCtxtExt as _;
35 /// Checks that it is legal to call methods of the trait corresponding
36 /// to `trait_id` (this only cares about the trait, not the specific
37 /// method that is called).
38 pub fn check_legal_trait_for_method_call(
41 receiver: Option<Span>,
45 if tcx.lang_items().drop_trait() == Some(trait_id) {
46 let mut err = struct_span_err!(tcx.sess, span, E0040, "explicit use of destructor method");
47 err.span_label(span, "explicit destructor calls not allowed");
49 let (sp, suggestion) = receiver
50 .and_then(|s| tcx.sess.source_map().span_to_snippet(s).ok())
51 .filter(|snippet| !snippet.is_empty())
52 .map(|snippet| (expr_span, format!("drop({snippet})")))
53 .unwrap_or_else(|| (span, "drop".to_string()));
57 "consider using `drop` function",
59 Applicability::MaybeIncorrect,
69 DeferredClosure(LocalDefId, ty::FnSig<'tcx>),
70 /// E.g., enum variant constructors.
71 Overloaded(MethodCallee<'tcx>),
74 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
77 call_expr: &'tcx hir::Expr<'tcx>,
78 callee_expr: &'tcx hir::Expr<'tcx>,
79 arg_exprs: &'tcx [hir::Expr<'tcx>],
80 expected: Expectation<'tcx>,
82 let original_callee_ty = match &callee_expr.kind {
83 hir::ExprKind::Path(hir::QPath::Resolved(..) | hir::QPath::TypeRelative(..)) => self
84 .check_expr_with_expectation_and_args(
86 Expectation::NoExpectation,
89 _ => self.check_expr(callee_expr),
92 let expr_ty = self.structurally_resolved_type(call_expr.span, original_callee_ty);
94 let mut autoderef = self.autoderef(callee_expr.span, expr_ty);
95 let mut result = None;
96 while result.is_none() && autoderef.next().is_some() {
97 result = self.try_overloaded_call_step(call_expr, callee_expr, arg_exprs, &autoderef);
99 self.register_predicates(autoderef.into_obligations());
101 let output = match result {
103 // this will report an error since original_callee_ty is not a fn
104 self.confirm_builtin_call(
113 Some(CallStep::Builtin(callee_ty)) => {
114 self.confirm_builtin_call(call_expr, callee_expr, callee_ty, arg_exprs, expected)
117 Some(CallStep::DeferredClosure(def_id, fn_sig)) => {
118 self.confirm_deferred_closure_call(call_expr, arg_exprs, expected, def_id, fn_sig)
121 Some(CallStep::Overloaded(method_callee)) => {
122 self.confirm_overloaded_call(call_expr, arg_exprs, expected, method_callee)
126 // we must check that return type of called functions is WF:
127 self.register_wf_obligation(output.into(), call_expr.span, traits::WellFormed(None));
132 #[instrument(level = "debug", skip(self, call_expr, callee_expr, arg_exprs, autoderef), ret)]
133 fn try_overloaded_call_step(
135 call_expr: &'tcx hir::Expr<'tcx>,
136 callee_expr: &'tcx hir::Expr<'tcx>,
137 arg_exprs: &'tcx [hir::Expr<'tcx>],
138 autoderef: &Autoderef<'a, 'tcx>,
139 ) -> Option<CallStep<'tcx>> {
141 self.structurally_resolved_type(autoderef.span(), autoderef.final_ty(false));
143 // If the callee is a bare function or a closure, then we're all set.
144 match *adjusted_ty.kind() {
145 ty::FnDef(..) | ty::FnPtr(_) => {
146 let adjustments = self.adjust_steps(autoderef);
147 self.apply_adjustments(callee_expr, adjustments);
148 return Some(CallStep::Builtin(adjusted_ty));
151 ty::Closure(def_id, substs) => {
152 let def_id = def_id.expect_local();
154 // Check whether this is a call to a closure where we
155 // haven't yet decided on whether the closure is fn vs
156 // fnmut vs fnonce. If so, we have to defer further processing.
157 if self.closure_kind(substs).is_none() {
158 let closure_sig = substs.as_closure().sig();
159 let closure_sig = self.replace_bound_vars_with_fresh_vars(
164 let adjustments = self.adjust_steps(autoderef);
165 self.record_deferred_call_resolution(
167 DeferredCallResolution {
173 closure_substs: substs,
176 return Some(CallStep::DeferredClosure(def_id, closure_sig));
180 // Hack: we know that there are traits implementing Fn for &F
181 // where F:Fn and so forth. In the particular case of types
182 // like `x: &mut FnMut()`, if there is a call `x()`, we would
183 // normally translate to `FnMut::call_mut(&mut x, ())`, but
184 // that winds up requiring `mut x: &mut FnMut()`. A little
185 // over the top. The simplest fix by far is to just ignore
186 // this case and deref again, so we wind up with
187 // `FnMut::call_mut(&mut *x, ())`.
188 ty::Ref(..) if autoderef.step_count() == 0 => {
199 // Now, we look for the implementation of a Fn trait on the object's type.
200 // We first do it with the explicit instruction to look for an impl of
201 // `Fn<Tuple>`, with the tuple `Tuple` having an arity corresponding
202 // to the number of call parameters.
203 // If that fails (or_else branch), we try again without specifying the
204 // shape of the tuple (hence the None). This allows to detect an Fn trait
205 // is implemented, and use this information for diagnostic.
206 self.try_overloaded_call_traits(call_expr, adjusted_ty, Some(arg_exprs))
207 .or_else(|| self.try_overloaded_call_traits(call_expr, adjusted_ty, None))
208 .map(|(autoref, method)| {
209 let mut adjustments = self.adjust_steps(autoderef);
210 adjustments.extend(autoref);
211 self.apply_adjustments(callee_expr, adjustments);
212 CallStep::Overloaded(method)
216 fn try_overloaded_call_traits(
218 call_expr: &hir::Expr<'_>,
219 adjusted_ty: Ty<'tcx>,
220 opt_arg_exprs: Option<&'tcx [hir::Expr<'tcx>]>,
221 ) -> Option<(Option<Adjustment<'tcx>>, MethodCallee<'tcx>)> {
222 // Try the options that are least restrictive on the caller first.
223 for (opt_trait_def_id, method_name, borrow) in [
224 (self.tcx.lang_items().fn_trait(), Ident::with_dummy_span(sym::call), true),
225 (self.tcx.lang_items().fn_mut_trait(), Ident::with_dummy_span(sym::call_mut), true),
226 (self.tcx.lang_items().fn_once_trait(), Ident::with_dummy_span(sym::call_once), false),
228 let Some(trait_def_id) = opt_trait_def_id else { continue };
230 let opt_input_types = opt_arg_exprs.map(|arg_exprs| {
231 [self.tcx.mk_tup(arg_exprs.iter().map(|e| {
232 self.next_ty_var(TypeVariableOrigin {
233 kind: TypeVariableOriginKind::TypeInference,
238 let opt_input_types = opt_input_types.as_ref().map(AsRef::as_ref);
240 if let Some(ok) = self.lookup_method_in_trait(
247 let method = self.register_infer_ok_obligations(ok);
248 let mut autoref = None;
250 // Check for &self vs &mut self in the method signature. Since this is either
251 // the Fn or FnMut trait, it should be one of those.
252 let ty::Ref(region, _, mutbl) = method.sig.inputs()[0].kind() else {
253 // The `fn`/`fn_mut` lang item is ill-formed, which should have
254 // caused an error elsewhere.
257 .delay_span_bug(call_expr.span, "input to call/call_mut is not a ref?");
261 let mutbl = match mutbl {
262 hir::Mutability::Not => AutoBorrowMutability::Not,
263 hir::Mutability::Mut => AutoBorrowMutability::Mut {
264 // For initial two-phase borrow
265 // deployment, conservatively omit
266 // overloaded function call ops.
267 allow_two_phase_borrow: AllowTwoPhase::No,
270 autoref = Some(Adjustment {
271 kind: Adjust::Borrow(AutoBorrow::Ref(*region, mutbl)),
272 target: method.sig.inputs()[0],
275 return Some((autoref, method));
282 /// Give appropriate suggestion when encountering `||{/* not callable */}()`, where the
283 /// likely intention is to call the closure, suggest `(||{})()`. (#55851)
284 fn identify_bad_closure_def_and_call(
286 err: &mut Diagnostic,
288 callee_node: &hir::ExprKind<'_>,
291 let hir = self.tcx.hir();
292 let parent_hir_id = hir.get_parent_node(hir_id);
293 let parent_node = hir.get(parent_hir_id);
295 hir::Node::Expr(hir::Expr {
296 kind: hir::ExprKind::Closure(&hir::Closure { fn_decl_span, body, .. }),
299 hir::ExprKind::Block(..),
300 ) = (parent_node, callee_node)
302 let fn_decl_span = if hir.body(body).generator_kind
303 == Some(hir::GeneratorKind::Async(hir::AsyncGeneratorKind::Closure))
305 // Actually need to unwrap a few more layers of HIR to get to
306 // the _real_ closure...
307 let async_closure = hir.get_parent_node(hir.get_parent_node(parent_hir_id));
308 if let hir::Node::Expr(hir::Expr {
309 kind: hir::ExprKind::Closure(&hir::Closure { fn_decl_span, .. }),
311 }) = hir.get(async_closure)
321 let start = fn_decl_span.shrink_to_lo();
322 let end = callee_span.shrink_to_hi();
323 err.multipart_suggestion(
324 "if you meant to create this closure and immediately call it, surround the \
325 closure with parentheses",
326 vec![(start, "(".to_string()), (end, ")".to_string())],
327 Applicability::MaybeIncorrect,
332 /// Give appropriate suggestion when encountering `[("a", 0) ("b", 1)]`, where the
333 /// likely intention is to create an array containing tuples.
334 fn maybe_suggest_bad_array_definition(
336 err: &mut Diagnostic,
337 call_expr: &'tcx hir::Expr<'tcx>,
338 callee_expr: &'tcx hir::Expr<'tcx>,
340 let hir_id = self.tcx.hir().get_parent_node(call_expr.hir_id);
341 let parent_node = self.tcx.hir().get(hir_id);
343 hir::Node::Expr(hir::Expr { kind: hir::ExprKind::Array(_), .. }),
344 hir::ExprKind::Tup(exp),
345 hir::ExprKind::Call(_, args),
346 ) = (parent_node, &callee_expr.kind, &call_expr.kind)
347 && args.len() == exp.len()
349 let start = callee_expr.span.shrink_to_hi();
352 "consider separating array elements with a comma",
354 Applicability::MaybeIncorrect,
361 fn confirm_builtin_call(
363 call_expr: &'tcx hir::Expr<'tcx>,
364 callee_expr: &'tcx hir::Expr<'tcx>,
366 arg_exprs: &'tcx [hir::Expr<'tcx>],
367 expected: Expectation<'tcx>,
369 let (fn_sig, def_id) = match *callee_ty.kind() {
370 ty::FnDef(def_id, subst) => {
371 let fn_sig = self.tcx.bound_fn_sig(def_id).subst(self.tcx, subst);
373 // Unit testing: function items annotated with
374 // `#[rustc_evaluate_where_clauses]` trigger special output
375 // to let us test the trait evaluation system.
376 if self.tcx.has_attr(def_id, sym::rustc_evaluate_where_clauses) {
377 let predicates = self.tcx.predicates_of(def_id);
378 let predicates = predicates.instantiate(self.tcx, subst);
379 for (predicate, predicate_span) in
380 predicates.predicates.iter().zip(&predicates.spans)
382 let obligation = Obligation::new(
383 ObligationCause::dummy_with_span(callee_expr.span),
387 let result = self.evaluate_obligation(&obligation);
392 &format!("evaluate({:?}) = {:?}", predicate, result),
394 .span_label(*predicate_span, "predicate")
398 (fn_sig, Some(def_id))
400 ty::FnPtr(sig) => (sig, None),
402 if let hir::ExprKind::Path(hir::QPath::Resolved(_, path)) = &callee_expr.kind
403 && let [segment] = path.segments
404 && let Some(mut diag) = self
408 .steal_diagnostic(segment.ident.span, StashKey::CallIntoMethod)
410 // Try suggesting `foo(a)` -> `a.foo()` if possible.
412 self.suggest_call_as_method(
427 self.report_invalid_callee(call_expr, callee_expr, callee_ty, arg_exprs);
429 // This is the "default" function signature, used in case of error.
430 // In that case, we check each argument against "error" in order to
431 // set up all the node type bindings.
433 ty::Binder::dummy(self.tcx.mk_fn_sig(
434 self.err_args(arg_exprs.len()).into_iter(),
437 hir::Unsafety::Normal,
445 // Replace any late-bound regions that appear in the function
446 // signature with region variables. We also have to
447 // renormalize the associated types at this point, since they
448 // previously appeared within a `Binder<>` and hence would not
449 // have been normalized before.
450 let fn_sig = self.replace_bound_vars_with_fresh_vars(call_expr.span, infer::FnCall, fn_sig);
451 let fn_sig = self.normalize_associated_types_in(call_expr.span, fn_sig);
453 // Call the generic checker.
454 let expected_arg_tys = self.expected_inputs_for_expected_output(
460 self.check_argument_types(
467 TupleArgumentsFlag::DontTupleArguments,
474 /// Attempts to reinterpret `method(rcvr, args...)` as `rcvr.method(args...)`
475 /// and suggesting the fix if the method probe is successful.
476 fn suggest_call_as_method(
478 diag: &mut Diagnostic,
479 segment: &'tcx hir::PathSegment<'tcx>,
480 arg_exprs: &'tcx [hir::Expr<'tcx>],
481 call_expr: &'tcx hir::Expr<'tcx>,
482 expected: Expectation<'tcx>,
483 ) -> Option<Ty<'tcx>> {
484 if let [callee_expr, rest @ ..] = arg_exprs {
485 let callee_ty = self.check_expr(callee_expr);
486 // First, do a probe with `IsSuggestion(true)` to avoid emitting
487 // any strange errors. If it's successful, then we'll do a true
497 // We didn't record the in scope traits during late resolution
498 // so we need to probe AllTraits unfortunately
499 ProbeScope::AllTraits,
504 let pick = self.confirm_method(
512 if pick.illegal_sized_bound.is_some() {
516 let up_to_rcvr_span = segment.ident.span.until(callee_expr.span);
517 let rest_span = callee_expr.span.shrink_to_hi().to(call_expr.span.shrink_to_hi());
518 let rest_snippet = if let Some(first) = rest.first() {
522 .span_to_snippet(first.span.to(call_expr.span.shrink_to_hi()))
527 if let Ok(rest_snippet) = rest_snippet {
528 let sugg = if callee_expr.precedence().order() >= PREC_POSTFIX {
530 (up_to_rcvr_span, "".to_string()),
531 (rest_span, format!(".{}({rest_snippet}", segment.ident)),
535 (up_to_rcvr_span, "(".to_string()),
536 (rest_span, format!(").{}({rest_snippet}", segment.ident)),
539 let self_ty = self.resolve_vars_if_possible(pick.callee.sig.inputs()[0]);
540 diag.multipart_suggestion(
542 "use the `.` operator to call the method `{}{}` on `{self_ty}`",
544 .associated_item(pick.callee.def_id)
545 .trait_container(self.tcx)
548 |trait_def_id| self.tcx.def_path_str(trait_def_id) + "::"
553 Applicability::MaybeIncorrect,
556 // Let's check the method fully now
557 let return_ty = self.check_method_argument_types(
562 TupleArgumentsFlag::DontTupleArguments,
566 return Some(return_ty);
573 fn report_invalid_callee(
575 call_expr: &'tcx hir::Expr<'tcx>,
576 callee_expr: &'tcx hir::Expr<'tcx>,
578 arg_exprs: &'tcx [hir::Expr<'tcx>],
580 let mut unit_variant = None;
581 if let hir::ExprKind::Path(qpath) = &callee_expr.kind
582 && let Res::Def(def::DefKind::Ctor(kind, def::CtorKind::Const), _)
583 = self.typeck_results.borrow().qpath_res(qpath, callee_expr.hir_id)
584 // Only suggest removing parens if there are no arguments
585 && arg_exprs.is_empty()
587 let descr = match kind {
588 def::CtorOf::Struct => "struct",
589 def::CtorOf::Variant => "enum variant",
591 let removal_span = callee_expr.span.shrink_to_hi().to(call_expr.span.shrink_to_hi());
592 unit_variant = Some((removal_span, descr, rustc_hir_pretty::qpath_to_string(qpath)));
595 let callee_ty = self.resolve_vars_if_possible(callee_ty);
596 let mut err = type_error_struct!(
601 "expected function, found {}",
602 match &unit_variant {
603 Some((_, kind, path)) => format!("{kind} `{path}`"),
604 None => format!("`{callee_ty}`"),
608 self.identify_bad_closure_def_and_call(
615 if let Some((removal_span, kind, path)) = &unit_variant {
616 err.span_suggestion_verbose(
619 "`{path}` is a unit {kind}, and does not take parentheses to be constructed",
622 Applicability::MachineApplicable,
626 let mut inner_callee_path = None;
627 let def = match callee_expr.kind {
628 hir::ExprKind::Path(ref qpath) => {
629 self.typeck_results.borrow().qpath_res(qpath, callee_expr.hir_id)
631 hir::ExprKind::Call(ref inner_callee, _) => {
632 // If the call spans more than one line and the callee kind is
633 // itself another `ExprCall`, that's a clue that we might just be
634 // missing a semicolon (Issue #51055)
635 let call_is_multiline = self.tcx.sess.source_map().is_multiline(call_expr.span);
636 if call_is_multiline {
638 callee_expr.span.shrink_to_hi(),
639 "consider using a semicolon here",
641 Applicability::MaybeIncorrect,
644 if let hir::ExprKind::Path(ref inner_qpath) = inner_callee.kind {
645 inner_callee_path = Some(inner_qpath);
646 self.typeck_results.borrow().qpath_res(inner_qpath, inner_callee.hir_id)
654 if !self.maybe_suggest_bad_array_definition(&mut err, call_expr, callee_expr) {
655 if let Some((maybe_def, output_ty, _)) =
656 self.extract_callable_info(callee_expr, callee_ty)
657 && !self.type_is_sized_modulo_regions(self.param_env, output_ty, callee_expr.span)
659 let descr = match maybe_def {
660 DefIdOrName::DefId(def_id) => self.tcx.def_kind(def_id).descr(def_id),
661 DefIdOrName::Name(name) => name,
665 format!("this {descr} returns an unsized value `{output_ty}`, so it cannot be called")
667 if let DefIdOrName::DefId(def_id) = maybe_def
668 && let Some(def_span) = self.tcx.hir().span_if_local(def_id)
670 err.span_label(def_span, "the callable type is defined here");
673 err.span_label(call_expr.span, "call expression requires function");
677 if let Some(span) = self.tcx.hir().res_span(def) {
678 let callee_ty = callee_ty.to_string();
679 let label = match (unit_variant, inner_callee_path) {
680 (Some((_, kind, path)), _) => Some(format!("{kind} `{path}` defined here")),
681 (_, Some(hir::QPath::Resolved(_, path))) => self
685 .span_to_snippet(path.span)
687 .map(|p| format!("`{p}` defined here returns `{callee_ty}`")),
690 // Emit a different diagnostic for local variables, as they are not
691 // type definitions themselves, but rather variables *of* that type.
692 Res::Local(hir_id) => Some(format!(
693 "`{}` has type `{}`",
694 self.tcx.hir().name(hir_id),
697 Res::Def(kind, def_id) if kind.ns() == Some(Namespace::ValueNS) => {
698 Some(format!("`{}` defined here", self.tcx.def_path_str(def_id),))
700 _ => Some(format!("`{callee_ty}` defined here")),
704 if let Some(label) = label {
705 err.span_label(span, label);
711 fn confirm_deferred_closure_call(
713 call_expr: &'tcx hir::Expr<'tcx>,
714 arg_exprs: &'tcx [hir::Expr<'tcx>],
715 expected: Expectation<'tcx>,
716 closure_def_id: LocalDefId,
717 fn_sig: ty::FnSig<'tcx>,
719 // `fn_sig` is the *signature* of the closure being called. We
720 // don't know the full details yet (`Fn` vs `FnMut` etc), but we
721 // do know the types expected for each argument and the return
724 let expected_arg_tys = self.expected_inputs_for_expected_output(
731 self.check_argument_types(
738 TupleArgumentsFlag::TupleArguments,
739 Some(closure_def_id.to_def_id()),
745 fn confirm_overloaded_call(
747 call_expr: &'tcx hir::Expr<'tcx>,
748 arg_exprs: &'tcx [hir::Expr<'tcx>],
749 expected: Expectation<'tcx>,
750 method_callee: MethodCallee<'tcx>,
752 let output_type = self.check_method_argument_types(
757 TupleArgumentsFlag::TupleArguments,
761 self.write_method_call(call_expr.hir_id, method_callee);
767 pub struct DeferredCallResolution<'tcx> {
768 call_expr: &'tcx hir::Expr<'tcx>,
769 callee_expr: &'tcx hir::Expr<'tcx>,
770 adjusted_ty: Ty<'tcx>,
771 adjustments: Vec<Adjustment<'tcx>>,
772 fn_sig: ty::FnSig<'tcx>,
773 closure_substs: SubstsRef<'tcx>,
776 impl<'a, 'tcx> DeferredCallResolution<'tcx> {
777 pub fn resolve(self, fcx: &FnCtxt<'a, 'tcx>) {
778 debug!("DeferredCallResolution::resolve() {:?}", self);
780 // we should not be invoked until the closure kind has been
781 // determined by upvar inference
782 assert!(fcx.closure_kind(self.closure_substs).is_some());
784 // We may now know enough to figure out fn vs fnmut etc.
785 match fcx.try_overloaded_call_traits(self.call_expr, self.adjusted_ty, None) {
786 Some((autoref, method_callee)) => {
787 // One problem is that when we get here, we are going
788 // to have a newly instantiated function signature
789 // from the call trait. This has to be reconciled with
790 // the older function signature we had before. In
791 // principle we *should* be able to fn_sigs(), but we
792 // can't because of the annoying need for a TypeTrace.
793 // (This always bites me, should find a way to
795 let method_sig = method_callee.sig;
797 debug!("attempt_resolution: method_callee={:?}", method_callee);
799 for (method_arg_ty, self_arg_ty) in
800 iter::zip(method_sig.inputs().iter().skip(1), self.fn_sig.inputs())
802 fcx.demand_eqtype(self.call_expr.span, *self_arg_ty, *method_arg_ty);
805 fcx.demand_eqtype(self.call_expr.span, method_sig.output(), self.fn_sig.output());
807 let mut adjustments = self.adjustments;
808 adjustments.extend(autoref);
809 fcx.apply_adjustments(self.callee_expr, adjustments);
811 fcx.write_method_call(self.call_expr.hir_id, method_callee);
814 // This can happen if `#![no_core]` is used and the `fn/fn_mut/fn_once`
815 // lang items are not defined (issue #86238).
816 let mut err = fcx.inh.tcx.sess.struct_span_err(
818 "failed to find an overloaded call trait for closure call",
821 "make sure the `fn`/`fn_mut`/`fn_once` lang items are defined \
822 and have associated `call`/`call_mut`/`call_once` functions",