Expand description
This module implements RFC 1946: Intra-rustdoc-links
Structs§
- Ambiguous
Links π - Diagnostic
Info π - Link
Collector π - Owned
Diagnostic πInfo - Preprocessed
Markdown πLink - 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.
- 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 itemtrait_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§
- Resolve
Res π