Struct Generator 

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

Main documentation generator.

This struct orchestrates the entire documentation generation process, coordinating between the context, format-specific generators, and progress reporting.

Example

let generator = Generator::new(&krate, &args)?;
generator.generate()?;

Implementations

impl<'a> Generator<'a>

pub fn new( krate: &'a Crate, args: &'a Args, config: RenderConfig, ) -> Result<Self, Error>

Create a new generator for the given crate and arguments.

This initializes the shared context including:

• Path map (item ID → module path)
• Impl map (type ID → impl blocks)
• Link registry for cross-references

Arguments

• krate - The parsed rustdoc JSON crate
• args - CLI arguments containing output path, format, and options
• config - Rendering configuration options

Errors

Returns an error if the root item cannot be found in the crate index.

pub fn generate(&self) -> Result<(), Error>

Generate markdown documentation.

This is the main entry point for documentation generation. It:

1. Creates the output directory
2. Sets up a progress bar
3. Dispatches to the format-specific generator (flat or nested)

Errors

Returns an error if any file operation fails.

pub fn generate_to_capture( krate: &Crate, format: CliOutputFormat, include_private: bool, ) -> Result<MarkdownCapture, Error>

Generate documentation to memory instead of disk.

This function mirrors generate() but captures all output in a MarkdownCapture struct instead of writing to the filesystem. Useful for testing and programmatic access to generated docs.

Arguments

• krate - The parsed rustdoc JSON crate
• format - Output format (Flat or Nested)
• include_private - Whether to include private items

Returns

A MarkdownCapture containing all generated markdown files.

Errors

Returns an error if the root item cannot be found in the crate index.

pub fn generate_to_capture_with_config( krate: &Crate, format: CliOutputFormat, include_private: bool, config: RenderConfig, ) -> Result<MarkdownCapture, Error>

Generate markdown to an in-memory capture with custom configuration.

This variant allows specifying a custom RenderConfig for testing different rendering options like hide_trivial_derives.

Arguments

• krate - The parsed rustdoc JSON crate
• format - Output format (Flat or Nested)
• include_private - Whether to include private items
• config - Custom rendering configuration

Returns

A MarkdownCapture containing all generated markdown files.

Errors

Returns an error if the root item cannot be found in the crate index.

pub fn run(krate: &'a Crate, args: &'a Args) -> Result<(), Error>

Convenience method to generate documentation in one call.

Creates a Generator and runs it immediately. For more control over the generation process, use new() and generate() separately.

Uses default RenderConfig. For custom configuration, use new() directly.

Arguments

• krate - The parsed rustdoc JSON crate
• args - CLI arguments containing output path, format, and options

Returns

Ok(()) on success, or an error if any file operation fails.

Errors

Returns an error if the root item cannot be found or if file operations fail.