Struct rustdoc::passes::collect_intra_doc_links::LinkCollector
source · struct LinkCollector<'a, 'tcx> {
cx: &'a mut DocContext<'tcx>,
visited_links: FxHashMap<ResolutionInfo, Option<(Res, Option<UrlFragment>)>>,
}
Fields§
§cx: &'a mut DocContext<'tcx>
§visited_links: FxHashMap<ResolutionInfo, Option<(Res, Option<UrlFragment>)>>
Cache the resolved links so we can avoid resolving (and emitting errors for) the same link.
The link will be None
if it could not be resolved (i.e. the error was cached).
Implementations§
source§impl<'a, 'tcx> LinkCollector<'a, 'tcx>
impl<'a, 'tcx> LinkCollector<'a, 'tcx>
sourcefn variant_field<'path>(
&self,
path_str: &'path str,
item_id: DefId,
module_id: DefId
) -> Result<(Res, DefId), UnresolvedPath<'path>>
fn variant_field<'path>( &self, path_str: &'path str, item_id: DefId, module_id: DefId ) -> Result<(Res, DefId), UnresolvedPath<'path>>
Given a full link, parse it as an enum struct variant.
In particular, this will return an error whenever there aren’t three full path segments left in the link.
sourcefn resolve_primitive_associated_item(
&self,
prim_ty: PrimitiveType,
ns: Namespace,
item_name: Symbol
) -> Vec<(Res, DefId)>
fn resolve_primitive_associated_item( &self, prim_ty: PrimitiveType, ns: Namespace, item_name: Symbol ) -> Vec<(Res, DefId)>
Given a primitive type, try to resolve an associated item.
fn resolve_self_ty( &self, path_str: &str, ns: Namespace, item_id: DefId ) -> Option<Res>
sourcefn resolve_path(
&self,
path_str: &str,
ns: Namespace,
item_id: DefId,
module_id: DefId
) -> Option<Res>
fn resolve_path( &self, path_str: &str, ns: Namespace, item_id: DefId, module_id: DefId ) -> Option<Res>
Convenience wrapper around doc_link_resolutions
.
This also handles resolving true
and false
as booleans.
NOTE: doc_link_resolutions
knows only about paths, not about types.
Associated items will never be resolved by this function.
sourcefn resolve<'path>(
&mut self,
path_str: &'path str,
ns: Namespace,
item_id: DefId,
module_id: DefId
) -> Result<Vec<(Res, Option<DefId>)>, UnresolvedPath<'path>>
fn resolve<'path>( &mut self, path_str: &'path str, ns: Namespace, item_id: DefId, module_id: DefId ) -> Result<Vec<(Res, Option<DefId>)>, UnresolvedPath<'path>>
Resolves a string as a path within a particular namespace. Returns an optional URL fragment in the case of variants and methods.
sourcefn def_id_to_res(&self, ty_id: DefId) -> Option<Res>
fn def_id_to_res(&self, ty_id: DefId) -> Option<Res>
Convert a DefId to a Res, where possible.
This is used for resolving type aliases.
sourcefn primitive_type_to_ty(&mut self, prim: PrimitiveType) -> Option<Ty<'tcx>>
fn primitive_type_to_ty(&mut self, prim: PrimitiveType) -> Option<Ty<'tcx>>
Convert a PrimitiveType to a Ty, where possible.
This is used for resolving trait impls for primitives
source§impl LinkCollector<'_, '_>
impl LinkCollector<'_, '_>
fn resolve_links(&mut self, item: &Item)
sourcefn resolve_link(
&mut self,
dox: &String,
item: &Item,
item_id: DefId,
module_id: DefId,
PreprocessedMarkdownLink: &PreprocessedMarkdownLink
) -> Option<ItemLink>
fn resolve_link( &mut self, dox: &String, item: &Item, item_id: DefId, module_id: DefId, PreprocessedMarkdownLink: &PreprocessedMarkdownLink ) -> Option<ItemLink>
This is the entry point for resolving an intra-doc link.
FIXME(jynelson): this is way too many arguments
fn verify_disambiguator( &self, path_str: &str, kind: DefKind, id: DefId, disambiguator: Option<Disambiguator>, item: &Item, diag_info: &DiagnosticInfo<'_> ) -> Option<()>
fn report_disambiguator_mismatch( &self, path_str: &str, specified: Disambiguator, resolved: Res, diag_info: &DiagnosticInfo<'_> )
fn report_rawptr_assoc_feature_gate( &self, dox: &str, ori_link: &MarkdownLinkRange, item: &Item )
fn resolve_with_disambiguator_cached( &mut self, key: ResolutionInfo, diag: DiagnosticInfo<'_>, cache_errors: bool, recoverable: bool ) -> Option<(Res, Option<UrlFragment>)>
sourcefn resolve_with_disambiguator(
&mut self,
key: &ResolutionInfo,
diag: DiagnosticInfo<'_>,
recoverable: bool
) -> Vec<(Res, Option<DefId>)>
fn resolve_with_disambiguator( &mut self, key: &ResolutionInfo, diag: DiagnosticInfo<'_>, recoverable: bool ) -> Vec<(Res, Option<DefId>)>
After parsing the disambiguator, resolve the main part of the link.
sourcefn resolve_display_text(
&mut self,
explicit_link: &Box<str>,
display_res_info: ResolutionInfo,
ori_link: &MarkdownLink,
diag_info: &DiagnosticInfo<'_>
)
fn resolve_display_text( &mut self, explicit_link: &Box<str>, display_res_info: ResolutionInfo, ori_link: &MarkdownLink, diag_info: &DiagnosticInfo<'_> )
Resolve display text if the provided link has separated parts of links.
For example:
Inline link [display_text](dest_link)
and reference link [display_text][reference_link]
has
separated parts of links.
Trait Implementations§
source§impl<'a, 'tcx> DocVisitor for LinkCollector<'a, 'tcx>
impl<'a, 'tcx> DocVisitor for LinkCollector<'a, 'tcx>
fn visit_item(&mut self, item: &Item)
source§fn visit_inner_recur(&mut self, kind: &ItemKind)
fn visit_inner_recur(&mut self, kind: &ItemKind)
source§fn visit_item_recur(&mut self, item: &Item)
fn visit_item_recur(&mut self, item: &Item)
fn visit_mod(&mut self, m: &Module)
fn visit_crate(&mut self, c: &Crate)
Auto Trait Implementations§
impl<'a, 'tcx> !RefUnwindSafe for LinkCollector<'a, 'tcx>
impl<'a, 'tcx> !Send for LinkCollector<'a, 'tcx>
impl<'a, 'tcx> !Sync for LinkCollector<'a, 'tcx>
impl<'a, 'tcx> Unpin for LinkCollector<'a, 'tcx>
impl<'a, 'tcx> !UnwindSafe for LinkCollector<'a, 'tcx>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 40 bytes