4 use rustc_ast::visit::{self, Visitor};
5 use rustc_ast::{self as ast, Crate, ItemKind, ModKind, NodeId, Path, CRATE_NODE_ID};
6 use rustc_ast_pretty::pprust;
7 use rustc_data_structures::fx::FxHashSet;
8 use rustc_errors::struct_span_err;
9 use rustc_errors::{Applicability, Diagnostic, DiagnosticBuilder, ErrorGuaranteed, MultiSpan};
10 use rustc_feature::BUILTIN_ATTRIBUTES;
11 use rustc_hir::def::Namespace::{self, *};
12 use rustc_hir::def::{self, CtorKind, CtorOf, DefKind, NonMacroAttrKind, PerNS};
13 use rustc_hir::def_id::{DefId, LocalDefId, CRATE_DEF_ID, LOCAL_CRATE};
14 use rustc_hir::PrimTy;
15 use rustc_index::vec::IndexVec;
16 use rustc_middle::bug;
17 use rustc_middle::ty::DefIdTree;
18 use rustc_session::lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE;
19 use rustc_session::lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS;
20 use rustc_session::lint::BuiltinLintDiagnostics;
21 use rustc_session::Session;
22 use rustc_span::edition::Edition;
23 use rustc_span::hygiene::MacroKind;
24 use rustc_span::lev_distance::find_best_match_for_name;
25 use rustc_span::source_map::SourceMap;
26 use rustc_span::symbol::{kw, sym, Ident, Symbol};
27 use rustc_span::{BytePos, Span, SyntaxContext};
29 use crate::imports::{Import, ImportKind, ImportResolver};
30 use crate::late::{PatternSource, Rib};
31 use crate::path_names_to_string;
32 use crate::{AmbiguityError, AmbiguityErrorMisc, AmbiguityKind, BindingError, Finalize};
33 use crate::{HasGenericParams, MacroRulesScope, Module, ModuleKind, ModuleOrUniformRoot};
34 use crate::{LexicalScopeBinding, NameBinding, NameBindingKind, PrivacyError, VisResolutionError};
35 use crate::{ParentScope, PathResult, ResolutionError, Resolver, Scope, ScopeSet};
36 use crate::{Segment, UseError};
41 type Res = def::Res<ast::NodeId>;
43 /// A vector of spans and replacements, a message and applicability.
44 pub(crate) type Suggestion = (Vec<(Span, String)>, String, Applicability);
46 /// Potential candidate for an undeclared or out-of-scope label - contains the ident of a
47 /// similarly named label and whether or not it is reachable.
48 pub(crate) type LabelSuggestion = (Ident, bool);
51 pub(crate) enum SuggestionTarget {
52 /// The target has a similar name as the name used by the programmer (probably a typo)
54 /// The target is the only valid item that can be used in the corresponding context
59 pub(crate) struct TypoSuggestion {
60 pub candidate: Symbol,
62 pub target: SuggestionTarget,
66 pub(crate) fn typo_from_res(candidate: Symbol, res: Res) -> TypoSuggestion {
67 Self { candidate, res, target: SuggestionTarget::SimilarlyNamed }
69 pub(crate) fn single_item_from_res(candidate: Symbol, res: Res) -> TypoSuggestion {
70 Self { candidate, res, target: SuggestionTarget::SingleItem }
74 /// A free importable items suggested in case of resolution failure.
75 #[derive(Debug, Clone)]
76 pub(crate) struct ImportSuggestion {
77 pub did: Option<DefId>,
78 pub descr: &'static str,
81 /// An extra note that should be issued if this item is suggested
82 pub note: Option<String>,
85 /// Adjust the impl span so that just the `impl` keyword is taken by removing
86 /// everything after `<` (`"impl<T> Iterator for A<T> {}" -> "impl"`) and
87 /// everything after the first whitespace (`"impl Iterator for A" -> "impl"`).
89 /// *Attention*: the method used is very fragile since it essentially duplicates the work of the
90 /// parser. If you need to use this function or something similar, please consider updating the
91 /// `source_map` functions and this function to something more robust.
92 fn reduce_impl_span_to_impl_keyword(sm: &SourceMap, impl_span: Span) -> Span {
93 let impl_span = sm.span_until_char(impl_span, '<');
94 sm.span_until_whitespace(impl_span)
97 impl<'a> Resolver<'a> {
98 pub(crate) fn report_errors(&mut self, krate: &Crate) {
99 self.report_with_use_injections(krate);
101 for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
102 let msg = "macro-expanded `macro_export` macros from the current crate \
103 cannot be referred to by absolute paths";
104 self.lint_buffer.buffer_lint_with_diagnostic(
105 MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
109 BuiltinLintDiagnostics::MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
113 for ambiguity_error in &self.ambiguity_errors {
114 self.report_ambiguity_error(ambiguity_error);
117 let mut reported_spans = FxHashSet::default();
118 for error in &self.privacy_errors {
119 if reported_spans.insert(error.dedup_span) {
120 self.report_privacy_error(error);
125 fn report_with_use_injections(&mut self, krate: &Crate) {
126 for UseError { mut err, candidates, def_id, instead, suggestion, path, is_call } in
127 self.use_injections.drain(..)
129 let (span, found_use) = if let Some(def_id) = def_id.as_local() {
130 UsePlacementFinder::check(krate, self.def_id_to_node_id[def_id])
135 if !candidates.is_empty() {
142 if instead { Instead::Yes } else { Instead::No },
144 DiagnosticMode::Normal,
148 } else if let Some((span, msg, sugg, appl)) = suggestion {
149 err.span_suggestion(span, msg, sugg, appl);
151 } else if let [segment] = path.as_slice() && is_call {
152 err.stash(segment.ident.span, rustc_errors::StashKey::CallIntoMethod);
159 pub(crate) fn report_conflict<'b>(
164 new_binding: &NameBinding<'b>,
165 old_binding: &NameBinding<'b>,
167 // Error on the second of two conflicting names
168 if old_binding.span.lo() > new_binding.span.lo() {
169 return self.report_conflict(parent, ident, ns, old_binding, new_binding);
172 let container = match parent.kind {
173 ModuleKind::Def(kind, _, _) => kind.descr(parent.def_id()),
174 ModuleKind::Block => "block",
177 let old_noun = match old_binding.is_import() {
179 false => "definition",
182 let new_participle = match new_binding.is_import() {
188 (ident.name, self.session.source_map().guess_head_span(new_binding.span));
190 if let Some(s) = self.name_already_seen.get(&name) {
196 let old_kind = match (ns, old_binding.module()) {
197 (ValueNS, _) => "value",
198 (MacroNS, _) => "macro",
199 (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
200 (TypeNS, Some(module)) if module.is_normal() => "module",
201 (TypeNS, Some(module)) if module.is_trait() => "trait",
202 (TypeNS, _) => "type",
205 let msg = format!("the name `{}` is defined multiple times", name);
207 let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
208 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
209 (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
210 true => struct_span_err!(self.session, span, E0254, "{}", msg),
211 false => struct_span_err!(self.session, span, E0260, "{}", msg),
213 _ => match (old_binding.is_import(), new_binding.is_import()) {
214 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
215 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
216 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
221 "`{}` must be defined only once in the {} namespace of this {}",
227 err.span_label(span, format!("`{}` re{} here", name, new_participle));
229 self.session.source_map().guess_head_span(old_binding.span),
230 format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
233 // See https://github.com/rust-lang/rust/issues/32354
234 use NameBindingKind::Import;
235 let import = match (&new_binding.kind, &old_binding.kind) {
236 // If there are two imports where one or both have attributes then prefer removing the
237 // import without attributes.
238 (Import { import: new, .. }, Import { import: old, .. })
240 !new_binding.span.is_dummy()
241 && !old_binding.span.is_dummy()
242 && (new.has_attributes || old.has_attributes)
245 if old.has_attributes {
246 Some((new, new_binding.span, true))
248 Some((old, old_binding.span, true))
251 // Otherwise prioritize the new binding.
252 (Import { import, .. }, other) if !new_binding.span.is_dummy() => {
253 Some((import, new_binding.span, other.is_import()))
255 (other, Import { import, .. }) if !old_binding.span.is_dummy() => {
256 Some((import, old_binding.span, other.is_import()))
261 // Check if the target of the use for both bindings is the same.
262 let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
263 let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
265 self.extern_prelude.get(&ident).map_or(true, |entry| entry.introduced_by_item);
266 // Only suggest removing an import if both bindings are to the same def, if both spans
267 // aren't dummy spans. Further, if both bindings are imports, then the ident must have
268 // been introduced by an item.
269 let should_remove_import = duplicate
271 && ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
274 Some((import, span, true)) if should_remove_import && import.is_nested() => {
275 self.add_suggestion_for_duplicate_nested_use(&mut err, import, span)
277 Some((import, _, true)) if should_remove_import && !import.is_glob() => {
278 // Simple case - remove the entire import. Due to the above match arm, this can
279 // only be a single use so just remove it entirely.
280 err.tool_only_span_suggestion(
281 import.use_span_with_attributes,
282 "remove unnecessary import",
284 Applicability::MaybeIncorrect,
287 Some((import, span, _)) => {
288 self.add_suggestion_for_rename_of_use(&mut err, name, import, span)
294 self.name_already_seen.insert(name, span);
297 /// This function adds a suggestion to change the binding name of a new import that conflicts
298 /// with an existing import.
300 /// ```text,ignore (diagnostic)
301 /// help: you can use `as` to change the binding name of the import
303 /// LL | use foo::bar as other_bar;
304 /// | ^^^^^^^^^^^^^^^^^^^^^
306 fn add_suggestion_for_rename_of_use(
308 err: &mut Diagnostic,
313 let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
314 format!("Other{}", name)
316 format!("other_{}", name)
319 let mut suggestion = None;
321 ImportKind::Single { type_ns_only: true, .. } => {
322 suggestion = Some(format!("self as {}", suggested_name))
324 ImportKind::Single { source, .. } => {
326 source.span.hi().0.checked_sub(binding_span.lo().0).map(|pos| pos as usize)
328 if let Ok(snippet) = self.session.source_map().span_to_snippet(binding_span) {
329 if pos <= snippet.len() {
330 suggestion = Some(format!(
334 if snippet.ends_with(';') { ";" } else { "" }
340 ImportKind::ExternCrate { source, target } => {
341 suggestion = Some(format!(
342 "extern crate {} as {};",
343 source.unwrap_or(target.name),
350 let rename_msg = "you can use `as` to change the binding name of the import";
351 if let Some(suggestion) = suggestion {
356 Applicability::MaybeIncorrect,
359 err.span_label(binding_span, rename_msg);
363 /// This function adds a suggestion to remove an unnecessary binding from an import that is
364 /// nested. In the following example, this function will be invoked to remove the `a` binding
365 /// in the second use statement:
367 /// ```ignore (diagnostic)
368 /// use issue_52891::a;
369 /// use issue_52891::{d, a, e};
372 /// The following suggestion will be added:
374 /// ```ignore (diagnostic)
375 /// use issue_52891::{d, a, e};
376 /// ^-- help: remove unnecessary import
379 /// If the nested use contains only one import then the suggestion will remove the entire
382 /// It is expected that the provided import is nested - this isn't checked by the
383 /// function. If this invariant is not upheld, this function's behaviour will be unexpected
384 /// as characters expected by span manipulations won't be present.
385 fn add_suggestion_for_duplicate_nested_use(
387 err: &mut Diagnostic,
391 assert!(import.is_nested());
392 let message = "remove unnecessary import";
394 // Two examples will be used to illustrate the span manipulations we're doing:
396 // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
397 // `a` and `import.use_span` is `issue_52891::{d, a, e};`.
398 // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
399 // `a` and `import.use_span` is `issue_52891::{d, e, a};`.
401 let (found_closing_brace, span) =
402 find_span_of_binding_until_next_binding(self.session, binding_span, import.use_span);
404 // If there was a closing brace then identify the span to remove any trailing commas from
406 if found_closing_brace {
407 if let Some(span) = extend_span_to_previous_binding(self.session, span) {
408 err.tool_only_span_suggestion(span, message, "", Applicability::MaybeIncorrect);
410 // Remove the entire line if we cannot extend the span back, this indicates an
411 // `issue_52891::{self}` case.
413 import.use_span_with_attributes,
416 Applicability::MaybeIncorrect,
423 err.span_suggestion(span, message, "", Applicability::MachineApplicable);
426 pub(crate) fn lint_if_path_starts_with_module(
428 finalize: Option<Finalize>,
430 second_binding: Option<&NameBinding<'_>>,
432 let Some(Finalize { node_id, root_span, .. }) = finalize else {
436 let first_name = match path.get(0) {
437 // In the 2018 edition this lint is a hard error, so nothing to do
438 Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
442 // We're only interested in `use` paths which should start with
443 // `{{root}}` currently.
444 if first_name != kw::PathRoot {
449 // If this import looks like `crate::...` it's already good
450 Some(Segment { ident, .. }) if ident.name == kw::Crate => return,
451 // Otherwise go below to see if it's an extern crate
453 // If the path has length one (and it's `PathRoot` most likely)
454 // then we don't know whether we're gonna be importing a crate or an
455 // item in our crate. Defer this lint to elsewhere
459 // If the first element of our path was actually resolved to an
460 // `ExternCrate` (also used for `crate::...`) then no need to issue a
461 // warning, this looks all good!
462 if let Some(binding) = second_binding {
463 if let NameBindingKind::Import { import, .. } = binding.kind {
464 // Careful: we still want to rewrite paths from renamed extern crates.
465 if let ImportKind::ExternCrate { source: None, .. } = import.kind {
471 let diag = BuiltinLintDiagnostics::AbsPathWithModule(root_span);
472 self.lint_buffer.buffer_lint_with_diagnostic(
473 ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
476 "absolute paths must start with `self`, `super`, \
477 `crate`, or an external crate name in the 2018 edition",
482 pub(crate) fn add_module_candidates(
485 names: &mut Vec<TypoSuggestion>,
486 filter_fn: &impl Fn(Res) -> bool,
487 ctxt: Option<SyntaxContext>,
489 for (key, resolution) in self.resolutions(module).borrow().iter() {
490 if let Some(binding) = resolution.borrow().binding {
491 let res = binding.res();
492 if filter_fn(res) && ctxt.map_or(true, |ctxt| ctxt == key.ident.span.ctxt()) {
493 names.push(TypoSuggestion::typo_from_res(key.ident.name, res));
499 /// Combines an error with provided span and emits it.
501 /// This takes the error provided, combines it with the span and any additional spans inside the
502 /// error and emits it.
503 pub(crate) fn report_error(&mut self, span: Span, resolution_error: ResolutionError<'a>) {
504 self.into_struct_error(span, resolution_error).emit();
507 pub(crate) fn into_struct_error(
510 resolution_error: ResolutionError<'a>,
511 ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
512 match resolution_error {
513 ResolutionError::GenericParamsFromOuterFunction(outer_res, has_generic_params) => {
514 let mut err = struct_span_err!(
518 "can't use generic parameters from outer function",
520 err.span_label(span, "use of generic parameter from outer function");
522 let sm = self.session.source_map();
523 let def_id = match outer_res {
524 Res::SelfTyParam { .. } => {
525 err.span_label(span, "can't use `Self` here");
528 Res::SelfTyAlias { alias_to: def_id, .. } => {
529 if let Some(impl_span) = self.opt_span(def_id) {
531 reduce_impl_span_to_impl_keyword(sm, impl_span),
532 "`Self` type implicitly declared here, by this `impl`",
535 err.span_label(span, "use a type here instead");
538 Res::Def(DefKind::TyParam, def_id) => {
539 if let Some(span) = self.opt_span(def_id) {
540 err.span_label(span, "type parameter from outer function");
544 Res::Def(DefKind::ConstParam, def_id) => {
545 if let Some(span) = self.opt_span(def_id) {
546 err.span_label(span, "const parameter from outer function");
552 "GenericParamsFromOuterFunction should only be used with \
553 Res::SelfTyParam, Res::SelfTyAlias, DefKind::TyParam or \
559 if let HasGenericParams::Yes(span) = has_generic_params {
560 // Try to retrieve the span of the function signature and generate a new
561 // message with a local type or const parameter.
562 let sugg_msg = "try using a local generic parameter instead";
563 let name = self.opt_name(def_id).unwrap_or(sym::T);
564 let (span, snippet) = if span.is_empty() {
565 let snippet = format!("<{}>", name);
568 let span = sm.span_through_char(span, '<').shrink_to_hi();
569 let snippet = format!("{}, ", name);
572 // Suggest the modification to the user
573 err.span_suggestion(span, sugg_msg, snippet, Applicability::MaybeIncorrect);
578 ResolutionError::NameAlreadyUsedInParameterList(name, first_use_span) => {
579 let mut err = struct_span_err!(
583 "the name `{}` is already used for a generic \
584 parameter in this item's generic parameters",
587 err.span_label(span, "already used");
588 err.span_label(first_use_span, format!("first use of `{}`", name));
591 ResolutionError::MethodNotMemberOfTrait(method, trait_, candidate) => {
592 let mut err = struct_span_err!(
596 "method `{}` is not a member of trait `{}`",
600 err.span_label(span, format!("not a member of trait `{}`", trait_));
601 if let Some(candidate) = candidate {
604 "there is an associated function with a similar name",
605 candidate.to_ident_string(),
606 Applicability::MaybeIncorrect,
611 ResolutionError::TypeNotMemberOfTrait(type_, trait_, candidate) => {
612 let mut err = struct_span_err!(
616 "type `{}` is not a member of trait `{}`",
620 err.span_label(span, format!("not a member of trait `{}`", trait_));
621 if let Some(candidate) = candidate {
624 "there is an associated type with a similar name",
625 candidate.to_ident_string(),
626 Applicability::MaybeIncorrect,
631 ResolutionError::ConstNotMemberOfTrait(const_, trait_, candidate) => {
632 let mut err = struct_span_err!(
636 "const `{}` is not a member of trait `{}`",
640 err.span_label(span, format!("not a member of trait `{}`", trait_));
641 if let Some(candidate) = candidate {
644 "there is an associated constant with a similar name",
645 candidate.to_ident_string(),
646 Applicability::MaybeIncorrect,
651 ResolutionError::VariableNotBoundInPattern(binding_error, parent_scope) => {
652 let BindingError { name, target, origin, could_be_path } = binding_error;
654 let target_sp = target.iter().copied().collect::<Vec<_>>();
655 let origin_sp = origin.iter().copied().collect::<Vec<_>>();
657 let msp = MultiSpan::from_spans(target_sp.clone());
658 let mut err = struct_span_err!(
662 "variable `{}` is not bound in all patterns",
665 for sp in target_sp {
666 err.span_label(sp, format!("pattern doesn't bind `{}`", name));
668 for sp in origin_sp {
669 err.span_label(sp, "variable not in all patterns");
672 let import_suggestions = self.lookup_import_candidates(
673 Ident::with_dummy_span(name),
676 &|res: Res| match res {
678 DefKind::Ctor(CtorOf::Variant, CtorKind::Const)
679 | DefKind::Ctor(CtorOf::Struct, CtorKind::Const)
681 | DefKind::AssocConst,
688 if import_suggestions.is_empty() {
689 let help_msg = format!(
690 "if you meant to match on a variant or a `const` item, consider \
691 making the path in the pattern qualified: `path::to::ModOrType::{}`",
694 err.span_help(span, &help_msg);
704 DiagnosticMode::Pattern,
710 ResolutionError::VariableBoundWithDifferentMode(variable_name, first_binding_span) => {
711 let mut err = struct_span_err!(
715 "variable `{}` is bound inconsistently across alternatives separated by `|`",
718 err.span_label(span, "bound in different ways");
719 err.span_label(first_binding_span, "first binding");
722 ResolutionError::IdentifierBoundMoreThanOnceInParameterList(identifier) => {
723 let mut err = struct_span_err!(
727 "identifier `{}` is bound more than once in this parameter list",
730 err.span_label(span, "used as parameter more than once");
733 ResolutionError::IdentifierBoundMoreThanOnceInSamePattern(identifier) => {
734 let mut err = struct_span_err!(
738 "identifier `{}` is bound more than once in the same pattern",
741 err.span_label(span, "used in a pattern more than once");
744 ResolutionError::UndeclaredLabel { name, suggestion } => {
745 let mut err = struct_span_err!(
749 "use of undeclared label `{}`",
753 err.span_label(span, format!("undeclared label `{}`", name));
756 // A reachable label with a similar name exists.
757 Some((ident, true)) => {
758 err.span_label(ident.span, "a label with a similar name is reachable");
761 "try using similarly named label",
763 Applicability::MaybeIncorrect,
766 // An unreachable label with a similar name exists.
767 Some((ident, false)) => {
770 "a label with a similar name exists but is unreachable",
773 // No similarly-named labels exist.
779 ResolutionError::SelfImportsOnlyAllowedWithin { root, span_with_rename } => {
780 let mut err = struct_span_err!(
785 "`self` imports are only allowed within a { } list"
788 // None of the suggestions below would help with a case like `use self`.
790 // use foo::bar::self -> foo::bar
791 // use foo::bar::self as abc -> foo::bar as abc
794 "consider importing the module directly",
796 Applicability::MachineApplicable,
799 // use foo::bar::self -> foo::bar::{self}
800 // use foo::bar::self as abc -> foo::bar::{self as abc}
802 (span_with_rename.shrink_to_lo(), "{".to_string()),
803 (span_with_rename.shrink_to_hi(), "}".to_string()),
805 err.multipart_suggestion(
806 "alternatively, use the multi-path `use` syntax to import `self`",
808 Applicability::MachineApplicable,
813 ResolutionError::SelfImportCanOnlyAppearOnceInTheList => {
814 let mut err = struct_span_err!(
818 "`self` import can only appear once in an import list"
820 err.span_label(span, "can only appear once in an import list");
823 ResolutionError::SelfImportOnlyInImportListWithNonEmptyPrefix => {
824 let mut err = struct_span_err!(
828 "`self` import can only appear in an import list with \
831 err.span_label(span, "can only appear in an import list with a non-empty prefix");
834 ResolutionError::FailedToResolve { label, suggestion } => {
836 struct_span_err!(self.session, span, E0433, "failed to resolve: {}", &label);
837 err.span_label(span, label);
839 if let Some((suggestions, msg, applicability)) = suggestion {
840 if suggestions.is_empty() {
844 err.multipart_suggestion(&msg, suggestions, applicability);
849 ResolutionError::CannotCaptureDynamicEnvironmentInFnItem => {
850 let mut err = struct_span_err!(
855 "can't capture dynamic environment in a fn item"
857 err.help("use the `|| { ... }` closure form instead");
860 ResolutionError::AttemptToUseNonConstantValueInConstant(ident, sugg, current) => {
861 let mut err = struct_span_err!(
865 "attempt to use a non-constant value in a constant"
868 // ^^^ given this Span
869 // ------- get this Span to have an applicable suggestion
872 // only do this if the const and usage of the non-constant value are on the same line
873 // the further the two are apart, the higher the chance of the suggestion being wrong
878 .span_extend_to_prev_str(ident.span, current, true, false);
881 Some(sp) if !self.session.source_map().is_multiline(sp) => {
882 let sp = sp.with_lo(BytePos(sp.lo().0 - (current.len() as u32)));
885 &format!("consider using `{}` instead of `{}`", sugg, current),
886 format!("{} {}", sugg, ident),
887 Applicability::MaybeIncorrect,
889 err.span_label(span, "non-constant value");
892 err.span_label(ident.span, &format!("this would need to be a `{}`", sugg));
898 ResolutionError::BindingShadowsSomethingUnacceptable {
904 shadowed_binding_span,
906 let shadowed_binding_descr = shadowed_binding.descr();
907 let mut err = struct_span_err!(
911 "{}s cannot shadow {}s",
912 shadowing_binding.descr(),
913 shadowed_binding_descr,
917 format!("cannot be named the same as {} {}", article, shadowed_binding_descr),
919 match (shadowing_binding, shadowed_binding) {
921 PatternSource::Match,
922 Res::Def(DefKind::Ctor(CtorOf::Variant | CtorOf::Struct, CtorKind::Fn), _),
926 "try specify the pattern arguments",
927 format!("{}(..)", name),
928 Applicability::Unspecified,
934 format!("the {} `{}` is {} here", shadowed_binding_descr, name, participle);
935 err.span_label(shadowed_binding_span, msg);
938 ResolutionError::ForwardDeclaredGenericParam => {
939 let mut err = struct_span_err!(
943 "generic parameters with a default cannot use \
944 forward declared identifiers"
946 err.span_label(span, "defaulted generic parameters cannot be forward declared");
949 ResolutionError::ParamInTyOfConstParam(name) => {
950 let mut err = struct_span_err!(
954 "the type of const parameters must not depend on other generic parameters"
958 format!("the type must not depend on the parameter `{}`", name),
962 ResolutionError::ParamInNonTrivialAnonConst { name, is_type } => {
963 let mut err = self.session.struct_span_err(
965 "generic parameters may not be used in const operations",
967 err.span_label(span, &format!("cannot perform const operation using `{}`", name));
970 err.note("type parameters may not be used in const expressions");
973 "const parameters may only be used as standalone arguments, i.e. `{}`",
978 if self.session.is_nightly_build() {
980 "use `#![feature(generic_const_exprs)]` to allow generic const expressions",
986 ResolutionError::SelfInGenericParamDefault => {
987 let mut err = struct_span_err!(
991 "generic parameters cannot use `Self` in their defaults"
993 err.span_label(span, "`Self` in generic parameter default");
996 ResolutionError::UnreachableLabel { name, definition_span, suggestion } => {
997 let mut err = struct_span_err!(
1001 "use of unreachable label `{}`",
1005 err.span_label(definition_span, "unreachable label defined here");
1006 err.span_label(span, format!("unreachable label `{}`", name));
1008 "labels are unreachable through functions, closures, async blocks and modules",
1012 // A reachable label with a similar name exists.
1013 Some((ident, true)) => {
1014 err.span_label(ident.span, "a label with a similar name is reachable");
1015 err.span_suggestion(
1017 "try using similarly named label",
1019 Applicability::MaybeIncorrect,
1022 // An unreachable label with a similar name exists.
1023 Some((ident, false)) => {
1026 "a label with a similar name exists but is also unreachable",
1029 // No similarly-named labels exist.
1035 ResolutionError::TraitImplMismatch {
1042 let mut err = self.session.struct_span_err_with_code(
1045 "item `{}` is an associated {}, which doesn't match its trait `{}`",
1046 name, kind, trait_path,
1050 err.span_label(span, "does not match trait");
1051 err.span_label(trait_item_span, "item in trait");
1054 ResolutionError::TraitImplDuplicate { name, trait_item_span, old_span } => {
1055 let mut err = struct_span_err!(
1059 "duplicate definitions with name `{}`:",
1062 err.span_label(old_span, "previous definition here");
1063 err.span_label(trait_item_span, "item in trait");
1064 err.span_label(span, "duplicate definition");
1067 ResolutionError::InvalidAsmSym => {
1068 let mut err = self.session.struct_span_err(span, "invalid `sym` operand");
1069 err.span_label(span, "is a local variable");
1070 err.help("`sym` operands must refer to either a function or a static");
1076 pub(crate) fn report_vis_error(
1078 vis_resolution_error: VisResolutionError<'_>,
1079 ) -> ErrorGuaranteed {
1080 match vis_resolution_error {
1081 VisResolutionError::Relative2018(span, path) => {
1082 let mut err = self.session.struct_span_err(
1084 "relative paths are not supported in visibilities in 2018 edition or later",
1086 err.span_suggestion(
1089 format!("crate::{}", pprust::path_to_string(&path)),
1090 Applicability::MaybeIncorrect,
1094 VisResolutionError::AncestorOnly(span) => struct_span_err!(
1098 "visibilities can only be restricted to ancestor modules"
1100 VisResolutionError::FailedToResolve(span, label, suggestion) => {
1101 self.into_struct_error(span, ResolutionError::FailedToResolve { label, suggestion })
1103 VisResolutionError::ExpectedFound(span, path_str, res) => {
1104 let mut err = struct_span_err!(
1108 "expected module, found {} `{}`",
1112 err.span_label(span, "not a module");
1115 VisResolutionError::Indeterminate(span) => struct_span_err!(
1119 "cannot determine resolution for the visibility"
1121 VisResolutionError::ModuleOnly(span) => {
1122 self.session.struct_span_err(span, "visibility must resolve to a module")
1128 /// Lookup typo candidate in scope for a macro or import.
1129 fn early_lookup_typo_candidate(
1131 scope_set: ScopeSet<'a>,
1132 parent_scope: &ParentScope<'a>,
1134 filter_fn: &impl Fn(Res) -> bool,
1135 ) -> Option<TypoSuggestion> {
1136 let mut suggestions = Vec::new();
1137 let ctxt = ident.span.ctxt();
1138 self.visit_scopes(scope_set, parent_scope, ctxt, |this, scope, use_prelude, _| {
1140 Scope::DeriveHelpers(expn_id) => {
1141 let res = Res::NonMacroAttr(NonMacroAttrKind::DeriveHelper);
1148 .map(|ident| TypoSuggestion::typo_from_res(ident.name, res)),
1152 Scope::DeriveHelpersCompat => {
1153 let res = Res::NonMacroAttr(NonMacroAttrKind::DeriveHelperCompat);
1155 for derive in parent_scope.derives {
1156 let parent_scope = &ParentScope { derives: &[], ..*parent_scope };
1157 if let Ok((Some(ext), _)) = this.resolve_macro_path(
1159 Some(MacroKind::Derive),
1167 .map(|name| TypoSuggestion::typo_from_res(*name, res)),
1173 Scope::MacroRules(macro_rules_scope) => {
1174 if let MacroRulesScope::Binding(macro_rules_binding) = macro_rules_scope.get() {
1175 let res = macro_rules_binding.binding.res();
1177 suggestions.push(TypoSuggestion::typo_from_res(
1178 macro_rules_binding.ident.name,
1184 Scope::CrateRoot => {
1185 let root_ident = Ident::new(kw::PathRoot, ident.span);
1186 let root_module = this.resolve_crate_root(root_ident);
1187 this.add_module_candidates(root_module, &mut suggestions, filter_fn, None);
1189 Scope::Module(module, _) => {
1190 this.add_module_candidates(module, &mut suggestions, filter_fn, None);
1192 Scope::MacroUsePrelude => {
1193 suggestions.extend(this.macro_use_prelude.iter().filter_map(
1195 let res = binding.res();
1196 filter_fn(res).then_some(TypoSuggestion::typo_from_res(*name, res))
1200 Scope::BuiltinAttrs => {
1201 let res = Res::NonMacroAttr(NonMacroAttrKind::Builtin(kw::Empty));
1206 .map(|attr| TypoSuggestion::typo_from_res(attr.name, res)),
1210 Scope::ExternPrelude => {
1211 suggestions.extend(this.extern_prelude.iter().filter_map(|(ident, _)| {
1212 let res = Res::Def(DefKind::Mod, CRATE_DEF_ID.to_def_id());
1213 filter_fn(res).then_some(TypoSuggestion::typo_from_res(ident.name, res))
1216 Scope::ToolPrelude => {
1217 let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
1219 this.registered_tools
1221 .map(|ident| TypoSuggestion::typo_from_res(ident.name, res)),
1224 Scope::StdLibPrelude => {
1225 if let Some(prelude) = this.prelude {
1226 let mut tmp_suggestions = Vec::new();
1227 this.add_module_candidates(prelude, &mut tmp_suggestions, filter_fn, None);
1231 .filter(|s| use_prelude || this.is_builtin_macro(s.res)),
1235 Scope::BuiltinTypes => {
1236 suggestions.extend(PrimTy::ALL.iter().filter_map(|prim_ty| {
1237 let res = Res::PrimTy(*prim_ty);
1238 filter_fn(res).then_some(TypoSuggestion::typo_from_res(prim_ty.name(), res))
1246 // Make sure error reporting is deterministic.
1247 suggestions.sort_by(|a, b| a.candidate.as_str().partial_cmp(b.candidate.as_str()).unwrap());
1249 match find_best_match_for_name(
1250 &suggestions.iter().map(|suggestion| suggestion.candidate).collect::<Vec<Symbol>>(),
1254 Some(found) if found != ident.name => {
1255 suggestions.into_iter().find(|suggestion| suggestion.candidate == found)
1261 fn lookup_import_candidates_from_module<FilterFn>(
1263 lookup_ident: Ident,
1264 namespace: Namespace,
1265 parent_scope: &ParentScope<'a>,
1266 start_module: Module<'a>,
1268 filter_fn: FilterFn,
1269 ) -> Vec<ImportSuggestion>
1271 FilterFn: Fn(Res) -> bool,
1273 let mut candidates = Vec::new();
1274 let mut seen_modules = FxHashSet::default();
1275 let mut worklist = vec![(start_module, Vec::<ast::PathSegment>::new(), true)];
1276 let mut worklist_via_import = vec![];
1278 while let Some((in_module, path_segments, accessible)) = match worklist.pop() {
1279 None => worklist_via_import.pop(),
1282 let in_module_is_extern = !in_module.def_id().is_local();
1283 // We have to visit module children in deterministic order to avoid
1284 // instabilities in reported imports (#43552).
1285 in_module.for_each_child(self, |this, ident, ns, name_binding| {
1286 // avoid non-importable candidates
1287 if !name_binding.is_importable() {
1291 let child_accessible =
1292 accessible && this.is_accessible_from(name_binding.vis, parent_scope.module);
1294 // do not venture inside inaccessible items of other crates
1295 if in_module_is_extern && !child_accessible {
1299 let via_import = name_binding.is_import() && !name_binding.is_extern_crate();
1301 // There is an assumption elsewhere that paths of variants are in the enum's
1302 // declaration and not imported. With this assumption, the variant component is
1303 // chopped and the rest of the path is assumed to be the enum's own path. For
1304 // errors where a variant is used as the type instead of the enum, this causes
1305 // funny looking invalid suggestions, i.e `foo` instead of `foo::MyEnum`.
1306 if via_import && name_binding.is_possibly_imported_variant() {
1310 // #90113: Do not count an inaccessible reexported item as a candidate.
1311 if let NameBindingKind::Import { binding, .. } = name_binding.kind {
1312 if this.is_accessible_from(binding.vis, parent_scope.module)
1313 && !this.is_accessible_from(name_binding.vis, parent_scope.module)
1319 // collect results based on the filter function
1320 // avoid suggesting anything from the same module in which we are resolving
1321 // avoid suggesting anything with a hygienic name
1322 if ident.name == lookup_ident.name
1324 && !ptr::eq(in_module, parent_scope.module)
1325 && !ident.span.normalize_to_macros_2_0().from_expansion()
1327 let res = name_binding.res();
1330 let mut segms = path_segments.clone();
1331 if lookup_ident.span.rust_2018() {
1332 // crate-local absolute paths start with `crate::` in edition 2018
1333 // FIXME: may also be stabilized for Rust 2015 (Issues #45477, #44660)
1334 segms.insert(0, ast::PathSegment::from_ident(crate_name));
1337 segms.push(ast::PathSegment::from_ident(ident));
1338 let path = Path { span: name_binding.span, segments: segms, tokens: None };
1339 let did = match res {
1340 Res::Def(DefKind::Ctor(..), did) => this.opt_parent(did),
1341 _ => res.opt_def_id(),
1344 if child_accessible {
1345 // Remove invisible match if exists
1346 if let Some(idx) = candidates
1348 .position(|v: &ImportSuggestion| v.did == did && !v.accessible)
1350 candidates.remove(idx);
1354 if candidates.iter().all(|v: &ImportSuggestion| v.did != did) {
1355 // See if we're recommending TryFrom, TryInto, or FromIterator and add
1356 // a note about editions
1357 let note = if let Some(did) = did {
1358 let requires_note = !did.is_local()
1359 && this.cstore().item_attrs_untracked(did, this.session).any(
1361 if attr.has_name(sym::rustc_diagnostic_item) {
1362 [sym::TryInto, sym::TryFrom, sym::FromIterator]
1364 .contains(&attr.value_str())
1371 requires_note.then(|| {
1373 "'{}' is included in the prelude starting in Edition 2021",
1374 path_names_to_string(&path)
1381 candidates.push(ImportSuggestion {
1385 accessible: child_accessible,
1392 // collect submodules to explore
1393 if let Some(module) = name_binding.module() {
1395 let mut path_segments = path_segments.clone();
1396 path_segments.push(ast::PathSegment::from_ident(ident));
1398 let is_extern_crate_that_also_appears_in_prelude =
1399 name_binding.is_extern_crate() && lookup_ident.span.rust_2018();
1401 if !is_extern_crate_that_also_appears_in_prelude {
1402 // add the module to the lookup
1403 if seen_modules.insert(module.def_id()) {
1404 if via_import { &mut worklist_via_import } else { &mut worklist }
1405 .push((module, path_segments, child_accessible));
1412 // If only some candidates are accessible, take just them
1413 if !candidates.iter().all(|v: &ImportSuggestion| !v.accessible) {
1414 candidates.retain(|x| x.accessible)
1420 /// When name resolution fails, this method can be used to look up candidate
1421 /// entities with the expected name. It allows filtering them using the
1422 /// supplied predicate (which should be used to only accept the types of
1423 /// definitions expected, e.g., traits). The lookup spans across all crates.
1425 /// N.B., the method does not look into imports, but this is not a problem,
1426 /// since we report the definitions (thus, the de-aliased imports).
1427 pub(crate) fn lookup_import_candidates<FilterFn>(
1429 lookup_ident: Ident,
1430 namespace: Namespace,
1431 parent_scope: &ParentScope<'a>,
1432 filter_fn: FilterFn,
1433 ) -> Vec<ImportSuggestion>
1435 FilterFn: Fn(Res) -> bool,
1437 let mut suggestions = self.lookup_import_candidates_from_module(
1442 Ident::with_dummy_span(kw::Crate),
1446 if lookup_ident.span.rust_2018() {
1447 let extern_prelude_names = self.extern_prelude.clone();
1448 for (ident, _) in extern_prelude_names.into_iter() {
1449 if ident.span.from_expansion() {
1450 // Idents are adjusted to the root context before being
1451 // resolved in the extern prelude, so reporting this to the
1452 // user is no help. This skips the injected
1453 // `extern crate std` in the 2018 edition, which would
1454 // otherwise cause duplicate suggestions.
1457 if let Some(crate_id) = self.crate_loader.maybe_process_path_extern(ident.name) {
1458 let crate_root = self.expect_module(crate_id.as_def_id());
1459 suggestions.extend(self.lookup_import_candidates_from_module(
1474 pub(crate) fn unresolved_macro_suggestions(
1476 err: &mut Diagnostic,
1477 macro_kind: MacroKind,
1478 parent_scope: &ParentScope<'a>,
1481 let is_expected = &|res: Res| res.macro_kind() == Some(macro_kind);
1482 let suggestion = self.early_lookup_typo_candidate(
1483 ScopeSet::Macro(macro_kind),
1488 self.add_typo_suggestion(err, suggestion, ident.span);
1490 let import_suggestions =
1491 self.lookup_import_candidates(ident, Namespace::MacroNS, parent_scope, is_expected);
1497 &import_suggestions,
1500 DiagnosticMode::Normal,
1504 if macro_kind == MacroKind::Derive && (ident.name == sym::Send || ident.name == sym::Sync) {
1505 let msg = format!("unsafe traits like `{}` should be implemented explicitly", ident);
1506 err.span_note(ident.span, &msg);
1509 if self.macro_names.contains(&ident.normalize_to_macros_2_0()) {
1510 err.help("have you added the `#[macro_use]` on the module/import?");
1513 if ident.name == kw::Default
1514 && let ModuleKind::Def(DefKind::Enum, def_id, _) = parent_scope.module.kind
1515 && let Some(span) = self.opt_span(def_id)
1517 let source_map = self.session.source_map();
1518 let head_span = source_map.guess_head_span(span);
1519 if let Ok(head) = source_map.span_to_snippet(head_span) {
1520 err.span_suggestion(head_span, "consider adding a derive", format!("#[derive(Default)]\n{head}"), Applicability::MaybeIncorrect);
1524 "consider adding `#[derive(Default)]` to this enum",
1528 for ns in [Namespace::MacroNS, Namespace::TypeNS, Namespace::ValueNS] {
1529 if let Ok(binding) = self.early_resolve_ident_in_lexical_scope(
1531 ScopeSet::All(ns, false),
1537 let desc = match binding.res() {
1538 Res::Def(DefKind::Macro(MacroKind::Bang), _) => {
1539 "a function-like macro".to_string()
1541 Res::Def(DefKind::Macro(MacroKind::Attr), _) | Res::NonMacroAttr(..) => {
1542 format!("an attribute: `#[{}]`", ident)
1544 Res::Def(DefKind::Macro(MacroKind::Derive), _) => {
1545 format!("a derive macro: `#[derive({})]`", ident)
1548 // Don't confuse the user with tool modules.
1551 Res::Def(DefKind::Trait, _) if macro_kind == MacroKind::Derive => {
1552 "only a trait, without a derive macro".to_string()
1558 macro_kind.article(),
1559 macro_kind.descr_expected(),
1562 if let crate::NameBindingKind::Import { import, .. } = binding.kind {
1563 if !import.span.is_dummy() {
1566 &format!("`{}` is imported here, but it is {}", ident, desc),
1568 // Silence the 'unused import' warning we might get,
1569 // since this diagnostic already covers that import.
1570 self.record_use(ident, binding, false);
1574 err.note(&format!("`{}` is in scope, but it is {}", ident, desc));
1580 pub(crate) fn add_typo_suggestion(
1582 err: &mut Diagnostic,
1583 suggestion: Option<TypoSuggestion>,
1586 let suggestion = match suggestion {
1587 None => return false,
1588 // We shouldn't suggest underscore.
1589 Some(suggestion) if suggestion.candidate == kw::Underscore => return false,
1590 Some(suggestion) => suggestion,
1592 let def_span = suggestion.res.opt_def_id().and_then(|def_id| match def_id.krate {
1593 LOCAL_CRATE => self.opt_span(def_id),
1594 _ => Some(self.cstore().get_span_untracked(def_id, self.session)),
1596 if let Some(def_span) = def_span {
1597 if span.overlaps(def_span) {
1598 // Don't suggest typo suggestion for itself like in the following:
1599 // error[E0423]: expected function, tuple struct or tuple variant, found struct `X`
1600 // --> $DIR/issue-64792-bad-unicode-ctor.rs:3:14
1603 // | ----------- `X` defined here
1605 // LL | const Y: X = X("ö");
1606 // | -------------^^^^^^- similarly named constant `Y` defined here
1608 // help: use struct literal syntax instead
1610 // LL | const Y: X = X {};
1612 // help: a constant with a similar name exists
1614 // LL | const Y: X = Y("ö");
1618 let prefix = match suggestion.target {
1619 SuggestionTarget::SimilarlyNamed => "similarly named ",
1620 SuggestionTarget::SingleItem => "",
1624 self.session.source_map().guess_head_span(def_span),
1626 "{}{} `{}` defined here",
1628 suggestion.res.descr(),
1629 suggestion.candidate,
1633 let msg = match suggestion.target {
1634 SuggestionTarget::SimilarlyNamed => format!(
1635 "{} {} with a similar name exists",
1636 suggestion.res.article(),
1637 suggestion.res.descr()
1639 SuggestionTarget::SingleItem => {
1640 format!("maybe you meant this {}", suggestion.res.descr())
1643 err.span_suggestion(span, &msg, suggestion.candidate, Applicability::MaybeIncorrect);
1647 fn binding_description(&self, b: &NameBinding<'_>, ident: Ident, from_prelude: bool) -> String {
1649 if b.span.is_dummy() || !self.session.source_map().is_span_accessible(b.span) {
1650 // These already contain the "built-in" prefix or look bad with it.
1652 !matches!(b.res(), Res::NonMacroAttr(..) | Res::PrimTy(..) | Res::ToolMod);
1653 let (built_in, from) = if from_prelude {
1654 ("", " from prelude")
1655 } else if b.is_extern_crate()
1657 && self.session.opts.externs.get(ident.as_str()).is_some()
1659 ("", " passed with `--extern`")
1660 } else if add_built_in {
1666 let a = if built_in.is_empty() { res.article() } else { "a" };
1667 format!("{a}{built_in} {thing}{from}", thing = res.descr())
1669 let introduced = if b.is_import() { "imported" } else { "defined" };
1670 format!("the {thing} {introduced} here", thing = res.descr())
1674 fn report_ambiguity_error(&self, ambiguity_error: &AmbiguityError<'_>) {
1675 let AmbiguityError { kind, ident, b1, b2, misc1, misc2 } = *ambiguity_error;
1676 let (b1, b2, misc1, misc2, swapped) = if b2.span.is_dummy() && !b1.span.is_dummy() {
1677 // We have to print the span-less alternative first, otherwise formatting looks bad.
1678 (b2, b1, misc2, misc1, true)
1680 (b1, b2, misc1, misc2, false)
1683 let mut err = struct_span_err!(self.session, ident.span, E0659, "`{ident}` is ambiguous");
1684 err.span_label(ident.span, "ambiguous name");
1685 err.note(&format!("ambiguous because of {}", kind.descr()));
1687 let mut could_refer_to = |b: &NameBinding<'_>, misc: AmbiguityErrorMisc, also: &str| {
1688 let what = self.binding_description(b, ident, misc == AmbiguityErrorMisc::FromPrelude);
1689 let note_msg = format!("`{ident}` could{also} refer to {what}");
1691 let thing = b.res().descr();
1692 let mut help_msgs = Vec::new();
1693 if b.is_glob_import()
1694 && (kind == AmbiguityKind::GlobVsGlob
1695 || kind == AmbiguityKind::GlobVsExpanded
1696 || kind == AmbiguityKind::GlobVsOuter && swapped != also.is_empty())
1698 help_msgs.push(format!(
1699 "consider adding an explicit import of `{ident}` to disambiguate"
1702 if b.is_extern_crate() && ident.span.rust_2018() {
1703 help_msgs.push(format!("use `::{ident}` to refer to this {thing} unambiguously"))
1705 if misc == AmbiguityErrorMisc::SuggestCrate {
1707 .push(format!("use `crate::{ident}` to refer to this {thing} unambiguously"))
1708 } else if misc == AmbiguityErrorMisc::SuggestSelf {
1710 .push(format!("use `self::{ident}` to refer to this {thing} unambiguously"))
1713 err.span_note(b.span, ¬e_msg);
1714 for (i, help_msg) in help_msgs.iter().enumerate() {
1715 let or = if i == 0 { "" } else { "or " };
1716 err.help(&format!("{}{}", or, help_msg));
1720 could_refer_to(b1, misc1, "");
1721 could_refer_to(b2, misc2, " also");
1725 /// If the binding refers to a tuple struct constructor with fields,
1726 /// returns the span of its fields.
1727 fn ctor_fields_span(&self, binding: &NameBinding<'_>) -> Option<Span> {
1728 if let NameBindingKind::Res(
1729 Res::Def(DefKind::Ctor(CtorOf::Struct, CtorKind::Fn), ctor_def_id),
1733 let def_id = self.parent(ctor_def_id);
1734 let fields = self.field_names.get(&def_id)?;
1735 return fields.iter().map(|name| name.span).reduce(Span::to); // None for `struct Foo()`
1740 fn report_privacy_error(&self, privacy_error: &PrivacyError<'_>) {
1741 let PrivacyError { ident, binding, .. } = *privacy_error;
1743 let res = binding.res();
1744 let ctor_fields_span = self.ctor_fields_span(binding);
1745 let plain_descr = res.descr().to_string();
1746 let nonimport_descr =
1747 if ctor_fields_span.is_some() { plain_descr + " constructor" } else { plain_descr };
1748 let import_descr = nonimport_descr.clone() + " import";
1750 |b: &NameBinding<'_>| if b.is_import() { &import_descr } else { &nonimport_descr };
1752 // Print the primary message.
1753 let descr = get_descr(binding);
1755 struct_span_err!(self.session, ident.span, E0603, "{} `{}` is private", descr, ident);
1756 err.span_label(ident.span, &format!("private {}", descr));
1757 if let Some(span) = ctor_fields_span {
1758 err.span_label(span, "a constructor is private if any of the fields is private");
1761 // Print the whole import chain to make it easier to see what happens.
1762 let first_binding = binding;
1763 let mut next_binding = Some(binding);
1764 let mut next_ident = ident;
1765 while let Some(binding) = next_binding {
1766 let name = next_ident;
1767 next_binding = match binding.kind {
1768 _ if res == Res::Err => None,
1769 NameBindingKind::Import { binding, import, .. } => match import.kind {
1770 _ if binding.span.is_dummy() => None,
1771 ImportKind::Single { source, .. } => {
1772 next_ident = source;
1775 ImportKind::Glob { .. } | ImportKind::MacroUse => Some(binding),
1776 ImportKind::ExternCrate { .. } => None,
1781 let first = ptr::eq(binding, first_binding);
1783 "{and_refers_to}the {item} `{name}`{which} is defined here{dots}",
1784 and_refers_to = if first { "" } else { "...and refers to " },
1785 item = get_descr(binding),
1786 which = if first { "" } else { " which" },
1787 dots = if next_binding.is_some() { "..." } else { "" },
1789 let def_span = self.session.source_map().guess_head_span(binding.span);
1790 let mut note_span = MultiSpan::from_span(def_span);
1791 if !first && binding.vis.is_public() {
1792 note_span.push_span_label(def_span, "consider importing it directly");
1794 err.span_note(note_span, &msg);
1800 pub(crate) fn find_similarly_named_module_or_crate(
1803 current_module: &Module<'a>,
1804 ) -> Option<Symbol> {
1805 let mut candidates = self
1808 .map(|(ident, _)| ident.name)
1812 .filter(|(_, module)| {
1813 current_module.is_ancestor_of(module) && !ptr::eq(current_module, *module)
1815 .flat_map(|(_, module)| module.kind.name()),
1817 .filter(|c| !c.to_string().is_empty())
1818 .collect::<Vec<_>>();
1821 match find_best_match_for_name(&candidates, ident, None) {
1822 Some(sugg) if sugg == ident => None,
1827 pub(crate) fn report_path_resolution_error(
1830 opt_ns: Option<Namespace>, // `None` indicates a module path in import
1831 parent_scope: &ParentScope<'a>,
1832 ribs: Option<&PerNS<Vec<Rib<'a>>>>,
1833 ignore_binding: Option<&'a NameBinding<'a>>,
1834 module: Option<ModuleOrUniformRoot<'a>>,
1837 ) -> (String, Option<Suggestion>) {
1838 let is_last = i == path.len() - 1;
1839 let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
1840 let module_res = match module {
1841 Some(ModuleOrUniformRoot::Module(module)) => module.res(),
1844 if module_res == self.graph_root.res() {
1845 let is_mod = |res| matches!(res, Res::Def(DefKind::Mod, _));
1846 let mut candidates = self.lookup_import_candidates(ident, TypeNS, parent_scope, is_mod);
1848 .sort_by_cached_key(|c| (c.path.segments.len(), pprust::path_to_string(&c.path)));
1849 if let Some(candidate) = candidates.get(0) {
1851 String::from("unresolved import"),
1853 vec![(ident.span, pprust::path_to_string(&candidate.path))],
1854 String::from("a similar path exists"),
1855 Applicability::MaybeIncorrect,
1858 } else if self.session.edition() == Edition::Edition2015 {
1860 format!("maybe a missing crate `{ident}`?"),
1864 "consider adding `extern crate {ident}` to use the `{ident}` crate"
1866 Applicability::MaybeIncorrect,
1870 (format!("could not find `{ident}` in the crate root"), None)
1873 let parent = path[i - 1].ident.name;
1874 let parent = match parent {
1875 // ::foo is mounted at the crate root for 2015, and is the extern
1876 // prelude for 2018+
1877 kw::PathRoot if self.session.edition() > Edition::Edition2015 => {
1878 "the list of imported crates".to_owned()
1880 kw::PathRoot | kw::Crate => "the crate root".to_owned(),
1881 _ => format!("`{parent}`"),
1884 let mut msg = format!("could not find `{}` in {}", ident, parent);
1885 if ns == TypeNS || ns == ValueNS {
1886 let ns_to_try = if ns == TypeNS { ValueNS } else { TypeNS };
1887 let binding = if let Some(module) = module {
1888 self.resolve_ident_in_module(
1896 } else if let Some(ribs) = ribs
1897 && let Some(TypeNS | ValueNS) = opt_ns
1899 match self.resolve_ident_in_lexical_scope(
1907 // we found a locally-imported or available item/module
1908 Some(LexicalScopeBinding::Item(binding)) => Some(binding),
1912 let scopes = ScopeSet::All(ns_to_try, opt_ns.is_none());
1913 self.early_resolve_ident_in_lexical_scope(
1922 if let Some(binding) = binding {
1923 let mut found = |what| {
1925 "expected {}, found {} `{}` in {}",
1932 if binding.module().is_some() {
1935 match binding.res() {
1936 Res::Def(kind, id) => found(kind.descr(id)),
1937 _ => found(ns_to_try.descr()),
1943 } else if ident.name == kw::SelfUpper {
1944 ("`Self` is only available in impls, traits, and type definitions".to_string(), None)
1945 } else if ident.name.as_str().chars().next().map_or(false, |c| c.is_ascii_uppercase()) {
1946 // Check whether the name refers to an item in the value namespace.
1947 let binding = if let Some(ribs) = ribs {
1948 self.resolve_ident_in_lexical_scope(
1959 let match_span = match binding {
1960 // Name matches a local variable. For example:
1963 // let Foo: &str = "";
1964 // println!("{}", Foo::Bar); // Name refers to local
1965 // // variable `Foo`.
1968 Some(LexicalScopeBinding::Res(Res::Local(id))) => {
1969 Some(*self.pat_span_map.get(&id).unwrap())
1971 // Name matches item from a local name binding
1972 // created by `use` declaration. For example:
1974 // pub Foo: &str = "";
1978 // println!("{}", Foo::Bar); // Name refers to local
1979 // // binding `Foo`.
1982 Some(LexicalScopeBinding::Item(name_binding)) => Some(name_binding.span),
1985 let suggestion = if let Some(span) = match_span {
1987 vec![(span, String::from(""))],
1988 format!("`{}` is defined here, but is not a type", ident),
1989 Applicability::MaybeIncorrect,
1995 (format!("use of undeclared type `{}`", ident), suggestion)
1997 let suggestion = if ident.name == sym::alloc {
2000 String::from("add `extern crate alloc` to use the `alloc` crate"),
2001 Applicability::MaybeIncorrect,
2004 self.find_similarly_named_module_or_crate(ident.name, &parent_scope.module).map(
2007 vec![(ident.span, sugg.to_string())],
2008 String::from("there is a crate or module with a similar name"),
2009 Applicability::MaybeIncorrect,
2014 (format!("use of undeclared crate or module `{}`", ident), suggestion)
2019 impl<'a, 'b> ImportResolver<'a, 'b> {
2020 /// Adds suggestions for a path that cannot be resolved.
2021 pub(crate) fn make_path_suggestion(
2024 mut path: Vec<Segment>,
2025 parent_scope: &ParentScope<'b>,
2026 ) -> Option<(Vec<Segment>, Option<String>)> {
2027 debug!("make_path_suggestion: span={:?} path={:?}", span, path);
2029 match (path.get(0), path.get(1)) {
2030 // `{{root}}::ident::...` on both editions.
2031 // On 2015 `{{root}}` is usually added implicitly.
2032 (Some(fst), Some(snd))
2033 if fst.ident.name == kw::PathRoot && !snd.ident.is_path_segment_keyword() => {}
2034 // `ident::...` on 2018.
2036 if fst.ident.span.rust_2018() && !fst.ident.is_path_segment_keyword() =>
2038 // Insert a placeholder that's later replaced by `self`/`super`/etc.
2039 path.insert(0, Segment::from_ident(Ident::empty()));
2044 self.make_missing_self_suggestion(path.clone(), parent_scope)
2045 .or_else(|| self.make_missing_crate_suggestion(path.clone(), parent_scope))
2046 .or_else(|| self.make_missing_super_suggestion(path.clone(), parent_scope))
2047 .or_else(|| self.make_external_crate_suggestion(path, parent_scope))
2050 /// Suggest a missing `self::` if that resolves to an correct module.
2054 /// LL | use foo::Bar;
2055 /// | ^^^ did you mean `self::foo`?
2057 fn make_missing_self_suggestion(
2059 mut path: Vec<Segment>,
2060 parent_scope: &ParentScope<'b>,
2061 ) -> Option<(Vec<Segment>, Option<String>)> {
2062 // Replace first ident with `self` and check if that is valid.
2063 path[0].ident.name = kw::SelfLower;
2064 let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2065 debug!("make_missing_self_suggestion: path={:?} result={:?}", path, result);
2066 if let PathResult::Module(..) = result { Some((path, None)) } else { None }
2069 /// Suggests a missing `crate::` if that resolves to an correct module.
2073 /// LL | use foo::Bar;
2074 /// | ^^^ did you mean `crate::foo`?
2076 fn make_missing_crate_suggestion(
2078 mut path: Vec<Segment>,
2079 parent_scope: &ParentScope<'b>,
2080 ) -> Option<(Vec<Segment>, Option<String>)> {
2081 // Replace first ident with `crate` and check if that is valid.
2082 path[0].ident.name = kw::Crate;
2083 let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2084 debug!("make_missing_crate_suggestion: path={:?} result={:?}", path, result);
2085 if let PathResult::Module(..) = result {
2089 "`use` statements changed in Rust 2018; read more at \
2090 <https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-\
2100 /// Suggests a missing `super::` if that resolves to an correct module.
2104 /// LL | use foo::Bar;
2105 /// | ^^^ did you mean `super::foo`?
2107 fn make_missing_super_suggestion(
2109 mut path: Vec<Segment>,
2110 parent_scope: &ParentScope<'b>,
2111 ) -> Option<(Vec<Segment>, Option<String>)> {
2112 // Replace first ident with `crate` and check if that is valid.
2113 path[0].ident.name = kw::Super;
2114 let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2115 debug!("make_missing_super_suggestion: path={:?} result={:?}", path, result);
2116 if let PathResult::Module(..) = result { Some((path, None)) } else { None }
2119 /// Suggests a missing external crate name if that resolves to an correct module.
2123 /// LL | use foobar::Baz;
2124 /// | ^^^^^^ did you mean `baz::foobar`?
2127 /// Used when importing a submodule of an external crate but missing that crate's
2128 /// name as the first part of path.
2129 fn make_external_crate_suggestion(
2131 mut path: Vec<Segment>,
2132 parent_scope: &ParentScope<'b>,
2133 ) -> Option<(Vec<Segment>, Option<String>)> {
2134 if path[1].ident.span.rust_2015() {
2138 // Sort extern crate names in *reverse* order to get
2139 // 1) some consistent ordering for emitted diagnostics, and
2140 // 2) `std` suggestions before `core` suggestions.
2141 let mut extern_crate_names =
2142 self.r.extern_prelude.iter().map(|(ident, _)| ident.name).collect::<Vec<_>>();
2143 extern_crate_names.sort_by(|a, b| b.as_str().partial_cmp(a.as_str()).unwrap());
2145 for name in extern_crate_names.into_iter() {
2146 // Replace first ident with a crate name and check if that is valid.
2147 path[0].ident.name = name;
2148 let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2150 "make_external_crate_suggestion: name={:?} path={:?} result={:?}",
2153 if let PathResult::Module(..) = result {
2154 return Some((path, None));
2161 /// Suggests importing a macro from the root of the crate rather than a module within
2165 /// help: a macro with this name exists at the root of the crate
2167 /// LL | use issue_59764::makro;
2168 /// | ^^^^^^^^^^^^^^^^^^
2170 /// = note: this could be because a macro annotated with `#[macro_export]` will be exported
2171 /// at the root of the crate instead of the module where it is defined
2173 pub(crate) fn check_for_module_export_macro(
2175 import: &'b Import<'b>,
2176 module: ModuleOrUniformRoot<'b>,
2178 ) -> Option<(Option<Suggestion>, Option<String>)> {
2179 let ModuleOrUniformRoot::Module(mut crate_module) = module else {
2183 while let Some(parent) = crate_module.parent {
2184 crate_module = parent;
2187 if ModuleOrUniformRoot::same_def(ModuleOrUniformRoot::Module(crate_module), module) {
2188 // Don't make a suggestion if the import was already from the root of the
2193 let resolutions = self.r.resolutions(crate_module).borrow();
2194 let resolution = resolutions.get(&self.r.new_key(ident, MacroNS))?;
2195 let binding = resolution.borrow().binding()?;
2196 if let Res::Def(DefKind::Macro(MacroKind::Bang), _) = binding.res() {
2197 let module_name = crate_module.kind.name().unwrap();
2198 let import_snippet = match import.kind {
2199 ImportKind::Single { source, target, .. } if source != target => {
2200 format!("{} as {}", source, target)
2202 _ => format!("{}", ident),
2205 let mut corrections: Vec<(Span, String)> = Vec::new();
2206 if !import.is_nested() {
2207 // Assume this is the easy case of `use issue_59764::foo::makro;` and just remove
2208 // intermediate segments.
2209 corrections.push((import.span, format!("{}::{}", module_name, import_snippet)));
2211 // Find the binding span (and any trailing commas and spaces).
2212 // ie. `use a::b::{c, d, e};`
2214 let (found_closing_brace, binding_span) = find_span_of_binding_until_next_binding(
2220 "check_for_module_export_macro: found_closing_brace={:?} binding_span={:?}",
2221 found_closing_brace, binding_span
2224 let mut removal_span = binding_span;
2225 if found_closing_brace {
2226 // If the binding span ended with a closing brace, as in the below example:
2227 // ie. `use a::b::{c, d};`
2229 // Then expand the span of characters to remove to include the previous
2230 // binding's trailing comma.
2231 // ie. `use a::b::{c, d};`
2233 if let Some(previous_span) =
2234 extend_span_to_previous_binding(self.r.session, binding_span)
2236 debug!("check_for_module_export_macro: previous_span={:?}", previous_span);
2237 removal_span = removal_span.with_lo(previous_span.lo());
2240 debug!("check_for_module_export_macro: removal_span={:?}", removal_span);
2242 // Remove the `removal_span`.
2243 corrections.push((removal_span, "".to_string()));
2245 // Find the span after the crate name and if it has nested imports immediately
2246 // after the crate name already.
2247 // ie. `use a::b::{c, d};`
2249 // or `use a::{b, c, d}};`
2251 let (has_nested, after_crate_name) = find_span_immediately_after_crate_name(
2257 "check_for_module_export_macro: has_nested={:?} after_crate_name={:?}",
2258 has_nested, after_crate_name
2261 let source_map = self.r.session.source_map();
2263 // Add the import to the start, with a `{` if required.
2264 let start_point = source_map.start_point(after_crate_name);
2265 if let Ok(start_snippet) = source_map.span_to_snippet(start_point) {
2269 // In this case, `start_snippet` must equal '{'.
2270 format!("{}{}, ", start_snippet, import_snippet)
2272 // In this case, add a `{`, then the moved import, then whatever
2273 // was there before.
2274 format!("{{{}, {}", import_snippet, start_snippet)
2279 // Add a `};` to the end if nested, matching the `{` added at the start.
2281 corrections.push((source_map.end_point(after_crate_name), "};".to_string()));
2285 let suggestion = Some((
2287 String::from("a macro with this name exists at the root of the crate"),
2288 Applicability::MaybeIncorrect,
2290 Some((suggestion, Some("this could be because a macro annotated with `#[macro_export]` will be exported \
2291 at the root of the crate instead of the module where it is defined"
2299 /// Given a `binding_span` of a binding within a use statement:
2301 /// ```ignore (illustrative)
2302 /// use foo::{a, b, c};
2306 /// then return the span until the next binding or the end of the statement:
2308 /// ```ignore (illustrative)
2309 /// use foo::{a, b, c};
2312 fn find_span_of_binding_until_next_binding(
2317 let source_map = sess.source_map();
2319 // Find the span of everything after the binding.
2320 // ie. `a, e};` or `a};`
2321 let binding_until_end = binding_span.with_hi(use_span.hi());
2323 // Find everything after the binding but not including the binding.
2324 // ie. `, e};` or `};`
2325 let after_binding_until_end = binding_until_end.with_lo(binding_span.hi());
2327 // Keep characters in the span until we encounter something that isn't a comma or
2331 // Also note whether a closing brace character was encountered. If there
2332 // was, then later go backwards to remove any trailing commas that are left.
2333 let mut found_closing_brace = false;
2334 let after_binding_until_next_binding =
2335 source_map.span_take_while(after_binding_until_end, |&ch| {
2337 found_closing_brace = true;
2339 ch == ' ' || ch == ','
2342 // Combine the two spans.
2343 // ie. `a, ` or `a`.
2345 // Removing these would leave `issue_52891::{d, e};` or `issue_52891::{d, e, };`
2346 let span = binding_span.with_hi(after_binding_until_next_binding.hi());
2348 (found_closing_brace, span)
2351 /// Given a `binding_span`, return the span through to the comma or opening brace of the previous
2354 /// ```ignore (illustrative)
2355 /// use foo::a::{a, b, c};
2356 /// // ^^--- binding span
2358 /// // returned span
2360 /// use foo::{a, b, c};
2361 /// // --- binding span
2363 fn extend_span_to_previous_binding(sess: &Session, binding_span: Span) -> Option<Span> {
2364 let source_map = sess.source_map();
2366 // `prev_source` will contain all of the source that came before the span.
2367 // Then split based on a command and take the first (ie. closest to our span)
2368 // snippet. In the example, this is a space.
2369 let prev_source = source_map.span_to_prev_source(binding_span).ok()?;
2371 let prev_comma = prev_source.rsplit(',').collect::<Vec<_>>();
2372 let prev_starting_brace = prev_source.rsplit('{').collect::<Vec<_>>();
2373 if prev_comma.len() <= 1 || prev_starting_brace.len() <= 1 {
2377 let prev_comma = prev_comma.first().unwrap();
2378 let prev_starting_brace = prev_starting_brace.first().unwrap();
2380 // If the amount of source code before the comma is greater than
2381 // the amount of source code before the starting brace then we've only
2382 // got one item in the nested item (eg. `issue_52891::{self}`).
2383 if prev_comma.len() > prev_starting_brace.len() {
2387 Some(binding_span.with_lo(BytePos(
2388 // Take away the number of bytes for the characters we've found and an
2389 // extra for the comma.
2390 binding_span.lo().0 - (prev_comma.as_bytes().len() as u32) - 1,
2394 /// Given a `use_span` of a binding within a use statement, returns the highlighted span and if
2395 /// it is a nested use tree.
2397 /// ```ignore (illustrative)
2398 /// use foo::a::{b, c};
2399 /// // ^^^^^^^^^^ -- false
2401 /// use foo::{a, b, c};
2402 /// // ^^^^^^^^^^ -- true
2404 /// use foo::{a, b::{c, d}};
2405 /// // ^^^^^^^^^^^^^^^ -- true
2407 fn find_span_immediately_after_crate_name(
2409 module_name: Symbol,
2413 "find_span_immediately_after_crate_name: module_name={:?} use_span={:?}",
2414 module_name, use_span
2416 let source_map = sess.source_map();
2418 // Using `use issue_59764::foo::{baz, makro};` as an example throughout..
2419 let mut num_colons = 0;
2420 // Find second colon.. `use issue_59764:`
2421 let until_second_colon = source_map.span_take_while(use_span, |c| {
2425 !matches!(c, ':' if num_colons == 2)
2427 // Find everything after the second colon.. `foo::{baz, makro};`
2428 let from_second_colon = use_span.with_lo(until_second_colon.hi() + BytePos(1));
2430 let mut found_a_non_whitespace_character = false;
2431 // Find the first non-whitespace character in `from_second_colon`.. `f`
2432 let after_second_colon = source_map.span_take_while(from_second_colon, |c| {
2433 if found_a_non_whitespace_character {
2436 if !c.is_whitespace() {
2437 found_a_non_whitespace_character = true;
2442 // Find the first `{` in from_second_colon.. `foo::{`
2443 let next_left_bracket = source_map.span_through_char(from_second_colon, '{');
2445 (next_left_bracket == after_second_colon, from_second_colon)
2448 /// A suggestion has already been emitted, change the wording slightly to clarify that both are
2449 /// independent options.
2455 /// Whether an existing place with an `use` item was found.
2461 /// Whether a binding is part of a pattern or a use statement. Used for diagnostics.
2462 enum DiagnosticMode {
2464 /// The binding is part of a pattern
2466 /// The binding is part of a use statement
2470 pub(crate) fn import_candidates(
2472 source_span: &IndexVec<LocalDefId, Span>,
2473 err: &mut Diagnostic,
2474 // This is `None` if all placement locations are inside expansions
2475 use_placement_span: Option<Span>,
2476 candidates: &[ImportSuggestion],
2486 DiagnosticMode::Import,
2491 /// When an entity with a given name is not available in scope, we search for
2492 /// entities with that name in all crates. This method allows outputting the
2493 /// results of this search in a programmer-friendly way
2496 source_span: &IndexVec<LocalDefId, Span>,
2497 err: &mut Diagnostic,
2498 // This is `None` if all placement locations are inside expansions
2499 use_placement_span: Option<Span>,
2500 candidates: &[ImportSuggestion],
2502 found_use: FoundUse,
2503 mode: DiagnosticMode,
2506 if candidates.is_empty() {
2510 let mut accessible_path_strings: Vec<(String, &str, Option<DefId>, &Option<String>)> =
2512 let mut inaccessible_path_strings: Vec<(String, &str, Option<DefId>, &Option<String>)> =
2515 candidates.iter().for_each(|c| {
2516 (if c.accessible { &mut accessible_path_strings } else { &mut inaccessible_path_strings })
2517 .push((path_names_to_string(&c.path), c.descr, c.did, &c.note))
2520 // we want consistent results across executions, but candidates are produced
2521 // by iterating through a hash map, so make sure they are ordered:
2522 for path_strings in [&mut accessible_path_strings, &mut inaccessible_path_strings] {
2523 path_strings.sort_by(|a, b| a.0.cmp(&b.0));
2524 let core_path_strings =
2525 path_strings.drain_filter(|p| p.0.starts_with("core::")).collect::<Vec<_>>();
2526 path_strings.extend(core_path_strings);
2527 path_strings.dedup_by(|a, b| a.0 == b.0);
2530 if !accessible_path_strings.is_empty() {
2531 let (determiner, kind, name) = if accessible_path_strings.len() == 1 {
2532 ("this", accessible_path_strings[0].1, format!(" `{}`", accessible_path_strings[0].0))
2534 ("one of these", "items", String::new())
2537 let instead = if let Instead::Yes = instead { " instead" } else { "" };
2538 let mut msg = if let DiagnosticMode::Pattern = mode {
2540 "if you meant to match on {}{}{}, use the full path in the pattern",
2544 format!("consider importing {} {}{}", determiner, kind, instead)
2547 for note in accessible_path_strings.iter().flat_map(|cand| cand.3.as_ref()) {
2551 if let Some(span) = use_placement_span {
2552 let add_use = match mode {
2553 DiagnosticMode::Pattern => {
2554 err.span_suggestions(
2557 accessible_path_strings.into_iter().map(|a| a.0),
2558 Applicability::MaybeIncorrect,
2562 DiagnosticMode::Import => "",
2563 DiagnosticMode::Normal => "use ",
2565 for candidate in &mut accessible_path_strings {
2566 // produce an additional newline to separate the new use statement
2567 // from the directly following item.
2568 let additional_newline = if let FoundUse::Yes = found_use { "" } else { "\n" };
2569 candidate.0 = format!("{}{};\n{}", add_use, &candidate.0, additional_newline);
2572 err.span_suggestions(
2575 accessible_path_strings.into_iter().map(|a| a.0),
2576 Applicability::MaybeIncorrect,
2578 if let [first, .., last] = &path[..] {
2579 let sp = first.ident.span.until(last.ident.span);
2580 if sp.can_be_used_for_suggestions() {
2581 err.span_suggestion_verbose(
2583 &format!("if you import `{}`, refer to it directly", last.ident),
2585 Applicability::Unspecified,
2592 for candidate in accessible_path_strings {
2594 msg.push_str(&candidate.0);
2599 } else if !matches!(mode, DiagnosticMode::Import) {
2600 assert!(!inaccessible_path_strings.is_empty());
2602 let prefix = if let DiagnosticMode::Pattern = mode {
2603 "you might have meant to match on "
2607 if inaccessible_path_strings.len() == 1 {
2608 let (name, descr, def_id, note) = &inaccessible_path_strings[0];
2610 "{}{} `{}`{} exists but is inaccessible",
2614 if let DiagnosticMode::Pattern = mode { ", which" } else { "" }
2617 if let Some(local_def_id) = def_id.and_then(|did| did.as_local()) {
2618 let span = source_span[local_def_id];
2619 let span = session.source_map().guess_head_span(span);
2620 let mut multi_span = MultiSpan::from_span(span);
2621 multi_span.push_span_label(span, "not accessible");
2622 err.span_note(multi_span, &msg);
2626 if let Some(note) = (*note).as_deref() {
2630 let (_, descr_first, _, _) = &inaccessible_path_strings[0];
2631 let descr = if inaccessible_path_strings
2634 .all(|(_, descr, _, _)| descr == descr_first)
2641 if descr.ends_with('s') { format!("{}es", descr) } else { format!("{}s", descr) };
2643 let mut msg = format!("{}these {} exist but are inaccessible", prefix, plural_descr);
2644 let mut has_colon = false;
2646 let mut spans = Vec::new();
2647 for (name, _, def_id, _) in &inaccessible_path_strings {
2648 if let Some(local_def_id) = def_id.and_then(|did| did.as_local()) {
2649 let span = source_span[local_def_id];
2650 let span = session.source_map().guess_head_span(span);
2651 spans.push((name, span));
2662 let mut multi_span = MultiSpan::from_spans(spans.iter().map(|(_, sp)| *sp).collect());
2663 for (name, span) in spans {
2664 multi_span.push_span_label(span, format!("`{}`: not accessible", name));
2667 for note in inaccessible_path_strings.iter().flat_map(|cand| cand.3.as_ref()) {
2671 err.span_note(multi_span, &msg);
2677 struct UsePlacementFinder {
2678 target_module: NodeId,
2679 first_legal_span: Option<Span>,
2680 first_use_span: Option<Span>,
2683 impl UsePlacementFinder {
2684 fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, FoundUse) {
2686 UsePlacementFinder { target_module, first_legal_span: None, first_use_span: None };
2687 finder.visit_crate(krate);
2688 if let Some(use_span) = finder.first_use_span {
2689 (Some(use_span), FoundUse::Yes)
2691 (finder.first_legal_span, FoundUse::No)
2696 impl<'tcx> visit::Visitor<'tcx> for UsePlacementFinder {
2697 fn visit_crate(&mut self, c: &Crate) {
2698 if self.target_module == CRATE_NODE_ID {
2699 let inject = c.spans.inject_use_span;
2700 if is_span_suitable_for_use_injection(inject) {
2701 self.first_legal_span = Some(inject);
2703 self.first_use_span = search_for_any_use_in_items(&c.items);
2706 visit::walk_crate(self, c);
2710 fn visit_item(&mut self, item: &'tcx ast::Item) {
2711 if self.target_module == item.id {
2712 if let ItemKind::Mod(_, ModKind::Loaded(items, _inline, mod_spans)) = &item.kind {
2713 let inject = mod_spans.inject_use_span;
2714 if is_span_suitable_for_use_injection(inject) {
2715 self.first_legal_span = Some(inject);
2717 self.first_use_span = search_for_any_use_in_items(items);
2721 visit::walk_item(self, item);
2726 fn search_for_any_use_in_items(items: &[P<ast::Item>]) -> Option<Span> {
2728 if let ItemKind::Use(..) = item.kind {
2729 if is_span_suitable_for_use_injection(item.span) {
2730 return Some(item.span.shrink_to_lo());
2737 fn is_span_suitable_for_use_injection(s: Span) -> bool {
2738 // don't suggest placing a use before the prelude
2739 // import or other generated ones
2743 /// Convert the given number into the corresponding ordinal
2744 pub(crate) fn ordinalize(v: usize) -> String {
2745 let suffix = match ((11..=13).contains(&(v % 100)), v % 10) {
2751 format!("{v}{suffix}")