Struct DocLinkProcessor 

pub struct DocLinkProcessor<'a> { /* private fields */ }

Processes doc comments to resolve intra-doc links to markdown links.

Rustdoc JSON includes a links field on each Item that maps intra-doc link text to item IDs. This processor uses that map along with the LinkRegistry to convert these to relative markdown links.

Supported Patterns

• [`Name`] - Backtick code links (most common)
• [`path::to::Item`] - Qualified path links
• [`Type::method`] - Method/associated item links
• [name] - Plain identifier links
• [text][ref] - Reference-style links
• [text][crate::path] - Path reference links

External Crate Links

Items from external crates are linked to docs.rs when possible.

Code Block Protection

Links inside fenced code blocks are not processed.

Implementations

impl<'a> DocLinkProcessor<'a>

pub fn with_index( krate: &'a Crate, link_registry: &'a LinkRegistry, current_file: &'a str, path_name_index: &HashMap<&'a str, Vec<Id>>, ) -> Self

Create a new processor with a pre-built path name index.

This is the preferred constructor when the index has already been built (e.g., in GeneratorContext), avoiding redundant index construction.

pub fn new( krate: &'a Crate, link_registry: &'a LinkRegistry, current_file: &'a str, ) -> Self

Create a new processor for the given context.

Builds the path name index internally. Prefer Self::with_index when the index has already been built to avoid redundant computation.

pub fn process(&self, docs: &str, item_links: &HashMap<String, Id>) -> String

Process a doc string and resolve all intra-doc links.

Uses the item’s links map to resolve link text to IDs, then uses LinkRegistry to convert IDs to relative paths.