Expand description
This module implements RFC 1946: Intra-rustdoc-links
Structs§
- Ambiguous
Links π - Diagnostic
Info π - Link
Collector π - Owned
Diagnostic πInfo - Preprocessing
Info π - Resolution
Info π - Unresolved
Path π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.
- Preprocessing
Error π - Res π
- Resolution
Failure π - Suggestion πA suggestion to show in a diagnostic.
- UrlFragment π
Constants§
Functions§
- ambiguity_
error πReport an ambiguity error, where there were multiple possible resolutions. - anchor_
failure πReport an anchor failure. - disambiguator_
error πReport an error in the link disambiguator. - full_
res π - 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. - 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. - 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 ignorepath_str
due to it being unlikely that it is an intra-doc link. - 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. - In case of an ambiguity or mismatched disambiguator, suggest the correct disambiguator.
- Find the associated item in the impl
impl_id
that corresponds to the trait associated itemtrait_assoc_id
. - trait_
impls_ πfor Given a type, return all trait impls in scope inmodule
for that type. Returns a set of pairs of(impl_id, trait_id)
.
Type Aliases§
- Resolve
Res π