Skip to main content

Module collect_intra_doc_links

rustdoc::passes

Module collect_intra_doc_links 

Source
Expand description

Resolves intra-doc links (RFC 1946).

Re-exports§

use std::borrow::Cow; 🔒
use std::fmt::Display; 🔒
use std::mem; 🔒
use std::ops::Range; 🔒
use rustc_attr_ir::Attribute; 🔒
use rustc_attr_ir::AttributeKind; 🔒
use rustc_attr_ir::find_attr; 🔒
use rustc_data_structures::fx::FxHashMap; 🔒
use rustc_data_structures::fx::FxHashSet; 🔒
use rustc_data_structures::fx::FxIndexMap; 🔒
use rustc_data_structures::fx::FxIndexSet; 🔒
use rustc_data_structures::intern::Interned; 🔒
use rustc_errors::Applicability; 🔒
use rustc_errors::Diag; 🔒
use rustc_errors::DiagMessage; 🔒
use rustc_hir::def::DefKind; 🔒
use rustc_hir::def::MacroKinds; 🔒
use rustc_hir::def::Namespace; 🔒
use rustc_hir::def::PerNS; 🔒
use rustc_hir::def_id::CRATE_DEF_ID; 🔒
use rustc_hir::def_id::DefId; 🔒
use rustc_hir::def_id::LOCAL_CRATE; 🔒
use rustc_hir::Mutability; 🔒
use rustc_hir::Safety; 🔒
use rustc_lint::Lint; 🔒
use rustc_middle::ty; 🔒
use rustc_middle::ty::Ty; 🔒
use rustc_middle::ty::TyCtxt; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::LinkType; 🔒
use rustc_resolve::rustdoc::DocStrings; 🔒
use rustc_resolve::rustdoc::MalformedGenerics; 🔒
use rustc_resolve::rustdoc::has_primitive_or_keyword_or_attribute_docs_hir; 🔒
use rustc_resolve::rustdoc::source_span_for_markdown_range; 🔒
use rustc_resolve::rustdoc::strip_generics_from_path; 🔒
use rustc_span::def_id::ModId; 🔒
use rustc_span::edit_distance::find_best_match_for_name; 🔒
use rustc_span::symbol::Ident; 🔒
use rustc_span::symbol::Symbol; 🔒
use rustc_span::symbol::sym; 🔒
use rustc_span::BytePos; 🔒
use rustc_span::bug; 🔒
use rustc_span::span_bug; 🔒
use rustc_structures::CrateType; 🔒
use smallvec::SmallVec; 🔒
use smallvec::smallvec; 🔒
use tracing::debug; 🔒
use tracing::info; 🔒
use tracing::instrument; 🔒
use tracing::instrument; 🔒
use tracing::trace; 🔒
use crate::clean::utils::find_nearest_parent_module; 🔒
use crate::clean; 🔒
use crate::clean::Crate; 🔒
use crate::clean::Item; 🔒
use crate::clean::ItemId; 🔒
use crate::clean::PrimitiveType; 🔒
use crate::clean::reexport_chain; 🔒
use crate::core::DocContext; 🔒
use crate::html::markdown::MarkdownLinkRange; 🔒
use crate::visit::DocVisitor; 🔒
use rustc_hir::def::Namespace::*; 🔒

Structs§

AmbiguousLinks 🔒
DiagnosticInfo 🔒
LinkCollection 🔒
LinkCollector 🔒
OwnedDiagnosticInfo 🔒
PreprocessedMarkdownLink 🔒
PreprocessingInfo 🔒
ResolutionInfo 🔒
UnresolvedPath 🔒
The link failed to resolve. resolution_failure should look to see if there’s a more helpful error that can be given.

Enums§

Disambiguator 🔒
Disambiguators for a link.
PreprocessingError 🔒
Res 🔒
ResolutionFailure 🔒
Suggestion 🔒
A suggestion to show in a diagnostic.
UrlFragment 🔒

Functions§

ambiguity_error 🔒
Report an ambiguity error, where there were multiple possible resolutions.
anchor_failure 🔒
Report an anchor failure.
collect_intra_doc_links 🔒
disambiguator_error 🔒
Report an error in the link disambiguator.
filter_assoc_items_by_name_and_namespace 🔒
full_res 🔒
is_assoc_item_on_alias_page 🔒
is_derive_trait_collision 🔒
Check for resolve collisions between a trait and its derive.
preprocess_link 🔒
Returns:
preprocessed_markdown_links 🔒
primitive_type_to_ty 🔒
Convert a PrimitiveType to a Ty, where possible.
privacy_error 🔒
Report a link from a public item to a private one.
range_between_backticks 🔒
Get the section of a link between the backticks, or the whole link if there aren’t any backticks.
report_anchor_conflict 🔒
report_diagnostic 🔒
Reports a diagnostic for an intra-doc link.
report_malformed_generics 🔒
report_multiple_anchors 🔒
resolution_failure 🔒
Reports a link that failed to resolve.
resolve_ambiguous_links 🔒
resolve_assoc_on_adt 🔒
resolve_assoc_on_primitive 🔒
resolve_assoc_on_simple_type 🔒
“Simple” i.e. an ADT, foreign type, etc. – not a type alias, primitive type, or other trickier type.
resolve_associated_item 🔒
Resolve an associated item, returning its containing page’s Res and the fragment targeting the associated item on its page.
resolve_associated_trait_item 🔒
Look to see if a resolved item has an associated item named item_name.
resolve_primitive 🔒
Resolve a primitive type or value.
resolve_primitive_inherent_assoc_item 🔒
Given a primitive type, try to resolve an associated item.
resolve_self_ty 🔒
resolve_structfield 🔒
should_ignore_link 🔒
Returns true if we should ignore path_str due to it being unlikely that it is an intra-doc link.
should_ignore_link_with_disambiguators 🔒
Returns true if we should ignore link due to it being unlikely that it is an intra-doc link. link should still have disambiguators if there were any.
suggest_disambiguator 🔒
In case of an ambiguity or mismatched disambiguator, suggest the correct disambiguator.
suggest_path_name_typo 🔒
trait_assoc_to_impl_assoc_item 🔒
Find the associated item in the impl impl_id that corresponds to the trait associated item trait_assoc_id.
trait_impls_for 🔒
Given a type, return all trait impls in scope in module for that type. Returns a set of pairs of (impl_id, trait_id).
ty_to_res 🔒
Convert a Ty to a Res, where possible.

Type Aliases§

ResolveRes 🔒