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>

source

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.

source

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.

source

fn resolve_self_ty( &self, path_str: &str, ns: Namespace, item_id: DefId ) -> Option<Res>

source

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.

source

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.

source

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.

source

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

fn resolve_associated_item( &mut self, root_res: Res, item_name: Symbol, ns: Namespace, module_id: DefId ) -> Vec<(Res, DefId)>

Resolve an associated item, returning its containing page’s Res and the fragment targeting the associated item on its page.

source§

impl LinkCollector<'_, '_>

This is the entry point for resolving an intra-doc link.

FIXME(jynelson): this is way too many arguments

source

fn verify_disambiguator( &self, path_str: &str, kind: DefKind, id: DefId, disambiguator: Option<Disambiguator>, item: &Item, diag_info: &DiagnosticInfo<'_> ) -> Option<()>

source

fn report_disambiguator_mismatch( &self, path_str: &str, specified: Disambiguator, resolved: Res, diag_info: &DiagnosticInfo<'_> )

source

fn report_rawptr_assoc_feature_gate( &self, dox: &str, ori_link: &MarkdownLinkRange, item: &Item )

source

fn resolve_with_disambiguator_cached( &mut self, key: ResolutionInfo, diag: DiagnosticInfo<'_>, cache_errors: bool, recoverable: bool ) -> Option<(Res, Option<UrlFragment>)>

source

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.

source

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>

source§

fn visit_item(&mut self, item: &Item)

source§

fn visit_inner_recur(&mut self, kind: &ItemKind)

don’t override!
source§

fn visit_item_recur(&mut self, item: &Item)

don’t override!
source§

fn visit_mod(&mut self, m: &Module)

source§

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> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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