Struct LinkRegistry 

pub struct LinkRegistry { /* private fields */ }

Registry mapping item IDs to their documentation file paths.

This is the central data structure for cross-reference resolution. It’s built once during generation and queried whenever we need to create links between items.

Implementations

impl LinkRegistry

pub fn build(krate: &Crate, flat_format: bool, include_private: bool) -> Self

Build a link registry by traversing all items in the crate.

This function walks the module tree starting from the root and records the file path where each item will be documented. The paths depend on the output format (flat vs nested).

Arguments

• krate - The parsed rustdoc crate containing all items
• flat_format - If true, use flat paths (mod.md); if false, use nested (mod/index.md)
• include_private - If true, include non-public items; if false, only public items

Returns

A populated LinkRegistry ready for link creation.

Algorithm

1. Start at the crate root module
2. For each top-level module: register it and recursively process children
3. For structs/enums/traits at root level: register them to index.md
4. Other items (functions, constants) are registered within their module’s file
5. Items are filtered by visibility unless include_private is true

pub fn get_path(&self, id: Id) -> Option<&String>

Get the file path where an item is documented.

Arguments

• id - The item’s unique ID from rustdoc JSON

Returns

The relative file path (e.g., "span.md" or "span/index.md"), or None if the item isn’t registered.

pub fn get_name(&self, id: Id) -> Option<&String>

Get the display name for an item.

Arguments

• id - The item’s unique ID from rustdoc JSON

Returns

The item’s name for display in links (e.g., "Span"), or None if the item isn’t registered.

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

Create a markdown link to an item from a given source file.

This is the main method used during markdown generation to create clickable links between documented items.

Arguments

• id - The target item’s ID
• from_path - The source file creating the link (e.g., "index.md")

Returns

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

Link Types

• Same file: Returns an anchor link (#itemname)
• Different file: Returns a relative path (../other/file.md)

Example

// From index.md linking to span.md
registry.create_link(&span_id, "index.md")
// Returns: Some("[`Span`](span.md)")

// From span/index.md linking to index.md
registry.create_link(&root_id, "span/index.md")
// Returns: Some("[`crate`](../index.md)")

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

Compute the relative path from one file to another.

This function calculates the relative path needed to navigate from one markdown file to another within the generated documentation. Uses pathdiff for robust cross-platform path calculation.

Arguments

• from - The source file path (e.g., "span/index.md")
• to - The target file path (e.g., "field/index.md")

Returns

A relative path string (e.g., "../field/index.md")

Examples

• Same directory: "index.md" → "span.md" = "span.md"
• Into subdirectory: "index.md" → "span/index.md" = "span/index.md"
• Up to parent: "span/index.md" → "index.md" = "../index.md"
• Sibling directory: "span/index.md" → "field/index.md" = "../field/index.md"

Trait Implementations

impl Debug for LinkRegistry

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

Formats the value using the given formatter.

impl Default for LinkRegistry

fn default() -> LinkRegistry

Returns the “default value” for a type.