rustdoc::passes

Module collect_intra_doc_links

Source
Expand description

This module implements RFC 1946: Intra-rustdoc-links

Structs§

AmbiguousLinks πŸ”’
DiagnosticInfo πŸ”’
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 πŸ”’

Constants§

COLLECT_INTRA_DOC_LINKS πŸ”’

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_derive_trait_collision πŸ”’
Check for resolve collisions between a trait and its derive.
preprocess_link πŸ”’
Returns:
preprocessed_markdown_links πŸ”’
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_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.
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.
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).

Type Aliases§

ResolveRes πŸ”’