Struct UnifiedLinkRegistry 

pub struct UnifiedLinkRegistry { /* private fields */ }

Registry mapping item IDs to documentation paths across multiple crates.

Unlike LinkRegistry which handles a single crate, this registry spans multiple crates and supports cross-crate link resolution with disambiguation based on local/primary crate preference.

Path Format

All paths use the nested format: {crate_name}/{module_path}/index.md

Examples:

• tracing/index.md (crate root)
• tracing/span/index.md (module)
• tracing_core/subscriber/index.md (cross-crate reference)

Link Resolution Priority

When resolving ambiguous names:

1. Items in the current crate (where the link appears)
2. Items in the primary crate (if specified via --primary-crate)
3. Items with the shortest qualified path

Performance

Uses hashbrown with raw entry API for zero-allocation lookups. This avoids allocating a String for the crate name on every lookup.

Implementations

impl UnifiedLinkRegistry

pub fn build(crates: &CrateCollection, primary_crate: Option<&str>) -> Self

Build a unified registry from a collection of crates.

Arguments

• crates - Collection of parsed crates
• primary_crate - Optional primary crate for disambiguation

Returns

A populated registry ready for link resolution.

pub fn get_path(&self, crate_name: &str, id: Id) -> Option<&CompactString>

Get the file path for an item in a specific crate.

Uses raw entry API for zero-allocation lookup.

pub fn get_name(&self, crate_name: &str, id: Id) -> Option<&CompactString>

Get the display name for an item.

Uses raw entry API for zero-allocation lookup.

pub fn get_re_export_source( &self, crate_name: &str, id: Id, ) -> Option<&CompactString>

Get the original source path for an external re-export.

Returns Some("crate::path::Item") if this item is a re-export from another crate, None otherwise.

pub fn resolve_reexport( &self, crate_name: &str, id: Id, ) -> Option<(CompactString, Id)>

Resolve through re-export chain to find the canonical item.

If the item is an external re-export, follows the source path to find the original crate and ID. Returns the original if found, otherwise returns None.

Arguments

• crate_name - The crate where the re-export appears
• id - The ID of the re-export Use item

Returns

Some((original_crate, original_id)) if the re-export chain can be resolved, None if there’s no re-export source or the original can’t be found.

pub fn resolve_name( &self, name: &str, current_crate: &str, ) -> Option<(CompactString, Id)>

Resolve an item name to its crate and ID.

Uses disambiguation priority:

1. Current crate (modules preferred over macros)
2. Primary crate (if set, modules preferred)
3. First module match, then first non-module match

pub fn resolve_path(&self, path: &str) -> Option<(CompactString, Id)>

Resolve a full path like regex_automata::Regex to its crate and ID.

This is used for resolving external re-exports where use_item.id is None but the source path is available.

Arguments

• path - Full path like regex_automata::Regex or tracing_core::span::Span

Returns

The (crate_name, item_id) if found in the registry.

pub fn create_link( &self, from_crate: &str, from_path: &str, to_crate: &str, to_id: Id, ) -> Option<String>

Create a markdown link from one file to another across crates.

Arguments

• from_crate - The crate where the link appears
• from_path - The file path where the link appears
• to_crate - The target crate
• to_id - The target item’s ID

Returns

A formatted markdown link like [Name](relative/path.md), or None if the target item isn’t registered.

pub fn compute_cross_crate_path(from: &str, to: &str) -> String

Compute relative path between files potentially in different crates.

Examples

• tracing/span/index.md to tracing_core/subscriber/index.md = ../../tracing_core/subscriber/index.md
• tracing/index.md to tracing/span/index.md = span/index.md

pub fn get_anchor(&self, crate_name: &str, id: Id) -> Option<String>

Get an anchor string for an item within its page.

Arguments

• crate_name - The crate containing the item
• id - The item’s ID

Returns

An anchor like #span or #enter for linking to specific items.

pub fn contains(&self, crate_name: &str, id: Id) -> bool

Check if an item exists in the registry.

Uses raw entry API for zero-allocation lookup.

pub fn len(&self) -> usize

Get the number of registered items.

pub fn is_empty(&self) -> bool

Check if the registry is empty.

Trait Implementations

impl Debug for UnifiedLinkRegistry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UnifiedLinkRegistry

fn default() -> UnifiedLinkRegistry

Returns the “default value” for a type.