Struct RustdocConfig 

pub struct RustdocConfig {
    pub source_path: String,
    pub output_dir: String,
    pub theme: DocTheme,
    pub cross_references: bool,
    pub features: Vec<String>,
    pub cfg_flags: Vec<String>,
    pub document_private: bool,
}

Configuration for a rustdoc generation run.

Fields

source_path: String

Root path of the source crate or workspace

output_dir: String

Output directory for generated HTML

theme: DocTheme

Documentation theme

cross_references: bool

Enable cross-reference linking between crates

features: Vec<String>

Extra features to pass via --features

cfg_flags: Vec<String>

Extra --cfg flags

document_private: bool

Whether to include private items (--document-private-items)

Implementations

impl RustdocConfig

pub fn for_crate(crate_path: &str, output_dir: &str) -> Self

Create a config pointing at a specific crate directory.

Trait Implementations

impl Clone for RustdocConfig

fn clone(&self) -> RustdocConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RustdocConfig

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

Formats the value using the given formatter.

impl Default for RustdocConfig

fn default() -> Self

Returns the “default value” for a type.