Struct RustdocBuilder 

pub struct RustdocBuilder { /* private fields */ }

Orchestrates cargo doc invocations for packages and workspaces.

Implementations

impl RustdocBuilder

pub fn new(config: RustdocConfig) -> Self

Create a new builder from a configuration.

pub fn config(&self) -> &RustdocConfig

Access the current configuration.

pub fn index(&self) -> &DocIndex

Access the documentation index built so far.

pub fn configure_theme(&mut self, theme: DocTheme)

Set the documentation theme.

pub fn generate_docs(&self) -> String

Generate the command to build documentation for a single package.

pub fn generate_package_docs(&self, package_name: &str) -> String

Generate the command to build documentation for a specific package within a workspace.

pub fn generate_workspace_docs(&self) -> String

Generate the command to build documentation for the entire workspace.

pub fn generate_search_index( &mut self, items: Vec<DocItem>, ) -> Result<&DocIndex, KernelError>

Build the search index from a list of discovered items.

In a real implementation this would parse the generated search-index.js or walk the source AST; here we accept a pre-collected list for testability.

pub fn crate_doc_path(&self, crate_name: &str) -> String

Return the HTML output root for a given crate.

pub fn index_html_path(&self) -> String

Return the full path to the top-level index.html.

pub fn server_config(&self, port: u16) -> DocServerConfig

Create a DocServerConfig for serving the generated docs.

pub fn cross_reference_flags(&self, crate_names: &[&str]) -> Vec<String>

Generate cross-reference extern flags for linking between crates in a workspace.