Struct GeneratorContext 

pub struct GeneratorContext<'a> {
    pub krate: &'a Crate,
    pub impl_map: HashMap<Id, Vec<&'a Impl>>,
    pub link_registry: LinkRegistry,
    pub args: &'a Args,
    pub config: RenderConfig,
    /* private fields */
}

Shared context containing all data needed for documentation generation.

This struct is passed to all rendering components and provides:

• Access to the parsed crate data
• Impl block lookup for rendering implementations
• Link registry for cross-references
• CLI configuration options

Fields

krate: &'a Crate

The parsed rustdoc JSON crate.

impl_map: HashMap<Id, Vec<&'a Impl>>

Maps type IDs to all impl blocks for that type.

Used for rendering “Implementations” and “Trait Implementations” sections.

link_registry: LinkRegistry

Registry for creating cross-reference links between items.

args: &'a Args

CLI arguments containing output path, format, and options.

config: RenderConfig

Rendering configuration options.

Implementations

impl<'a> GeneratorContext<'a>

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

Create a new generator context from crate data and CLI arguments.

Builds the path map, impl map, and link registry needed for generation.

Arguments

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

pub fn set_source_dir(&mut self, source_dir: &Path)

Set the source directory for path transformation.

This can be called after construction if a .source_* directory is detected or specified via CLI. Only has effect if source_locations is enabled in the config.

pub const fn should_include_item(&self, item: &Item) -> bool

Check if an item should be included based on visibility settings.

By default, all items are included. If --exclude-private is set, only public items are included.

Visibility Levels

• Public - Always included
• Crate, Restricted, Default - Included by default, excluded with --exclude-private

pub fn count_modules(&self, item: &Item) -> usize

Count the total number of modules that will be generated.

Used to initialize the progress bar with the correct total. Respects the --exclude-private flag when counting.

Trait Implementations

impl ItemAccess for GeneratorContext<'_>

fn krate(&self) -> &Crate

Get the crate being documented.

fn crate_name(&self) -> &str

Get the crate name.

fn get_item(&self, id: &Id) -> Option<&Item>

Get an item by its ID.

fn get_impls(&self, id: &Id) -> Option<&[&Impl]>

Get impl blocks for a type.

fn crate_version(&self) -> Option<&str>

Get the crate version for display in headers.

fn render_config(&self) -> &RenderConfig

Get the rendering configuration.

fn source_path_config_for_file( &self, current_file: &str, ) -> Option<SourcePathConfig>

Get source path config for a specific file.

impl ItemFilter for GeneratorContext<'_>

fn should_include_item(&self, item: &Item) -> bool

Check if an item should be included based on visibility.

fn include_private(&self) -> bool

Whether private items should be included.

fn include_blanket_impls(&self) -> bool

Whether blanket trait implementations should be included.

impl LinkResolver for GeneratorContext<'_>

fn link_registry(&self) -> Option<&LinkRegistry>

Get the link registry for single-crate mode.

fn process_docs(&self, item: &Item, current_file: &str) -> Option<String>

Process documentation string with intra-doc link resolution.

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

Create a markdown link to an item.