Module rustdoc::passes::collect_intra_doc_links[−][src]

Expand description

This module implements RFC 1946: Intra-rustdoc-links

Structs

CachedLink
DiagnosticInfo
LinkCollector
PreprocessingInfo
ResolutionInfo

Enums

AnchorFailure
Disambiguator

Disambiguators for a link.

ErrorKind

Top-level errors emitted by this pass.

MalformedGenerics
PreprocessingError
Res
ResolutionFailure

A link failed to resolve.

Suggestion

A suggestion to show in a diagnostic.

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.

handle_variant

Given an enum variant’s res, return the res of its enum and the associated fragment.

is_derive_trait_collision

Check for resolve collisions between a trait and its derive.

preprocess_link

Returns:

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_diagnostic

Reports a diagnostic for an intra-doc link.

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.

strip_generics_from_path
strip_generics_from_path_segment
suggest_disambiguator

In case of an ambiguity or mismatched disambiguator, suggest the correct disambiguator.

traits_implemented_by

Given a type, return all traits in scope in module implemented by that type.

Type Definitions

ResolveRes