Struct AuditReport 

pub struct AuditReport {
    pub summary: AuditSummary,
    pub file_results: Vec<FileAuditResult>,
    pub issues: Vec<AuditIssue>,
    pub recommendations: Vec<Recommendation>,
    pub timestamp: DateTime<Utc>,
    pub audit_config: AuditReportConfig,
}

Available on crate feature doc-audit only.

Comprehensive audit report containing all findings and statistics.

Fields

summary: AuditSummary

High-level summary of the audit results

file_results: Vec<FileAuditResult>

Detailed results for each audited file

issues: Vec<AuditIssue>

All issues found during the audit

recommendations: Vec<Recommendation>

Actionable recommendations for improvements

timestamp: DateTime<Utc>

When the audit was performed

audit_config: AuditReportConfig

Configuration used for the audit

Implementations

impl AuditReport

pub fn new(config: AuditReportConfig) -> AuditReport

Create a new audit report with the given configuration.

pub fn add_file_result(&mut self, file_result: FileAuditResult)

Add a file result to the report.

pub fn add_issue(&mut self, issue: AuditIssue)

Add an issue to the report.

pub fn add_recommendation(&mut self, recommendation: Recommendation)

Add a recommendation to the report.

pub fn calculate_summary(&mut self)

Calculate and update the summary statistics.

pub fn passed(&self) -> bool

Check if the audit passed (no critical issues).

pub fn issues_by_category(&self) -> HashMap<IssueCategory, Vec<&AuditIssue>>

Get issues by category.

pub fn issues_by_severity(&self) -> HashMap<IssueSeverity, Vec<&AuditIssue>>

Get issues by severity.

pub fn issues_for_file(&self, file_path: &PathBuf) -> Vec<&AuditIssue>

Get issues for a specific file.

Trait Implementations

impl Clone for AuditReport

fn clone(&self) -> AuditReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuditReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuditReport

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.