Struct AuditConfig 

pub struct AuditConfig {
    pub workspace_path: PathBuf,
    pub docs_path: PathBuf,
    pub excluded_files: Vec<String>,
    pub excluded_crates: Vec<String>,
    pub severity_threshold: IssueSeverity,
    pub fail_on_critical: bool,
    pub example_timeout: Duration,
    pub output_format: OutputFormat,
    pub database_path: Option<PathBuf>,
    pub verbose: bool,
    pub quiet: bool,
}

Available on crate feature doc-audit only.

Configuration for the documentation audit system.

Fields

workspace_path: PathBuf

Path to the workspace root containing Cargo.toml

docs_path: PathBuf

Path to the documentation directory

excluded_files: Vec<String>

Files to exclude from audit (glob patterns)

excluded_crates: Vec<String>

Crates to exclude from analysis

severity_threshold: IssueSeverity

Minimum severity level to report

fail_on_critical: bool

Whether to fail CI/CD on critical issues

example_timeout: Duration

Timeout for compiling code examples

output_format: OutputFormat

Output format for reports

database_path: Option<PathBuf>

Path to audit database (for incremental audits)

verbose: bool

Enable verbose logging

quiet: bool

Enable quiet mode (minimal output)

Implementations

impl AuditConfig

pub fn builder() -> AuditConfigBuilder

Create a new builder.

pub fn from_file<P>(path: P) -> Result<AuditConfig, AuditError>

where P: Into<PathBuf>,

Load configuration from a TOML file.

pub fn save_to_file<P>(&self, path: P) -> Result<(), AuditError>

where P: Into<PathBuf>,

Save configuration to a TOML file.

pub fn get_database_path(&self) -> PathBuf

Get the default database path if none is configured.

Trait Implementations

impl Clone for AuditConfig

fn clone(&self) -> AuditConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditConfig

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

Formats the value using the given formatter.

impl Default for AuditConfig

fn default() -> AuditConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuditConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<AuditConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuditConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.