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)
.