Struct RiskReport 

pub struct RiskReport {
    pub overall: RiskScore,
    pub per_file: Vec<FileRisk>,
    pub summary: RiskSummary,
}

Complete risk analysis for a set of diffs.

Examples

use argus_difflens::parser::parse_unified_diff;
use argus_difflens::risk::compute_risk;

let diff = "diff --git a/f.rs b/f.rs\n\
            --- a/f.rs\n\
            +++ b/f.rs\n\
            @@ -1,2 +1,3 @@\n\
             line\n\
            +new\n";
let files = parse_unified_diff(diff).unwrap();
let report = compute_risk(&files);
assert!(report.overall.total >= 0.0);

Fields

overall: RiskScore

Aggregate risk score across all files.

per_file: Vec<FileRisk>

Per-file risk breakdown.

summary: RiskSummary

High-level summary statistics.

Implementations

impl RiskReport

pub fn to_markdown(&self) -> String

Render the report as a markdown string.

Examples

use argus_difflens::risk::compute_risk;

let report = compute_risk(&[]);
let md = report.to_markdown();
assert!(md.contains("# Risk Report"));

Trait Implementations

impl Clone for RiskReport

fn clone(&self) -> RiskReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RiskReport

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

Formats the value using the given formatter.

impl Display for RiskReport

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

Formats the value using the given formatter.

impl Serialize for RiskReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.