Struct AuditReport 

pub struct AuditReport {
    pub gates: Vec<GateResult>,
}

Aggregate audit report.

Fields

gates: Vec<GateResult>

Per-gate results in registration order.

Implementations

impl AuditReport

pub fn max_severity(&self) -> Option<Severity>

Returns the highest severity present across all gates, or None if no findings were produced.

Examples

use ssg::audit::AuditReport;
let r = AuditReport { gates: vec![] };
assert!(r.max_severity().is_none());

pub fn should_fail(&self, fail_on: Severity) -> bool

Returns true when the report contains at least one finding at fail_on or higher.

Examples

use ssg::audit::{AuditReport, Severity};
let r = AuditReport { gates: vec![] };
assert!(!r.should_fail(Severity::Error));

pub const fn len(&self) -> usize

Total number of registered gates (skipped or not).

Examples

use ssg::audit::AuditReport;
let r = AuditReport { gates: vec![] };
assert_eq!(r.len(), 0);

pub const fn is_empty(&self) -> bool

true when no gates ran.

Examples

use ssg::audit::AuditReport;
let r = AuditReport { gates: vec![] };
assert!(r.is_empty());

pub fn print_text(&self)

Convenience: prints the rich text formatter to stdout.

Examples

use ssg::audit::AuditReport;
let r = AuditReport { gates: vec![] };
r.print_text(); // emits nothing for an empty report

pub fn print_json(&self) -> Result<(), SsgError>

Convenience: prints the JSON formatter to stdout.

Errors

Propagates any JSON serialisation error from crate::audit::output::json::format.

Examples

use ssg::audit::AuditReport;
let r = AuditReport { gates: vec![] };
r.print_json().unwrap();

pub fn print_junit(&self)

Convenience: prints the JUnit XML formatter to stdout.

Examples

use ssg::audit::AuditReport;
let r = AuditReport { gates: vec![] };
r.print_junit();

pub fn print_sarif(&self)

Convenience: prints the SARIF v2.1.0 formatter to stdout (#562).

Examples

use ssg::audit::AuditReport;
let r = AuditReport { gates: vec![] };
r.print_sarif();

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.