Struct GeneratorConfig 

pub struct GeneratorConfig {
    pub output_format: OutputFormat,
    pub include_examples: bool,
    pub validate_examples: bool,
    pub include_type_info: bool,
    pub include_cross_refs: bool,
    pub max_hierarchy_depth: usize,
    pub include_private: bool,
    pub custom_styling: Option<String>,
}

Configuration for the API reference generator

Fields

output_format: OutputFormat

Output format for the generated documentation

include_examples: bool

Whether to include code examples in the output

validate_examples: bool

Whether to validate examples by compilation

include_type_info: bool

Whether to extract type information

include_cross_refs: bool

Whether to generate cross-references

max_hierarchy_depth: usize

Maximum depth for trait hierarchy analysis

include_private: bool

Whether to include private items

custom_styling: Option<String>

Custom CSS/styling for HTML output

Implementations

impl GeneratorConfig

pub fn new() -> Self

Create a new generator configuration with default settings

pub fn with_output_format(self, format: OutputFormat) -> Self

Set the output format

pub fn with_validation(self, validate: bool) -> Self

Enable or disable example validation

pub fn with_examples(self, include: bool) -> Self

Enable or disable example inclusion

pub fn with_max_depth(self, depth: usize) -> Self

Set maximum hierarchy depth

pub fn with_private_items(self, include: bool) -> Self

Include private items in documentation

pub fn with_custom_styling(self, css: Option<String>) -> Self

Set custom CSS styling for HTML output

pub fn with_type_info(self, include: bool) -> Self

Enable or disable type information extraction

pub fn with_cross_refs(self, include: bool) -> Self

Enable or disable cross-reference generation

Trait Implementations

impl Clone for GeneratorConfig

fn clone(&self) -> GeneratorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratorConfig

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

Formats the value using the given formatter.

impl Default for GeneratorConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GeneratorConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GeneratorConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.