powerio-pkg 0.5.0

The .pio.json compiler package: a versioned envelope around one PowerIO IR payload with explicit model kind, provenance, source maps, structured diagnostics, validation, and lowering history.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! The package-level validation summary.

use serde::{Deserialize, Serialize};

use crate::diagnostics::{DiagnosticSeverity, StructuredDiagnostic};

/// Overall validation status, ordered worst-last.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ValidationStatus {
    Ok,
    Info,
    Warning,
    Error,
    Fatal,
}

impl ValidationStatus {
    fn from_severity(s: DiagnosticSeverity) -> Self {
        match s {
            DiagnosticSeverity::Debug => ValidationStatus::Ok,
            DiagnosticSeverity::Info => ValidationStatus::Info,
            DiagnosticSeverity::Warning => ValidationStatus::Warning,
            DiagnosticSeverity::Error => ValidationStatus::Error,
            DiagnosticSeverity::Fatal => ValidationStatus::Fatal,
        }
    }
}

/// Counts per severity. All five are always present; zero where unused.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct ValidationCounts {
    #[serde(default)]
    pub fatal: u32,
    #[serde(default)]
    pub error: u32,
    #[serde(default)]
    pub warning: u32,
    #[serde(default)]
    pub info: u32,
    #[serde(default)]
    pub debug: u32,
}

impl ValidationCounts {
    fn add(&mut self, s: DiagnosticSeverity) {
        match s {
            DiagnosticSeverity::Fatal => self.fatal += 1,
            DiagnosticSeverity::Error => self.error += 1,
            DiagnosticSeverity::Warning => self.warning += 1,
            DiagnosticSeverity::Info => self.info += 1,
            DiagnosticSeverity::Debug => self.debug += 1,
        }
    }
}

/// The status of one named validation pass.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct ValidationPass {
    pub name: String,
    pub status: ValidationStatus,
}

impl ValidationPass {
    pub fn new(name: impl Into<String>, status: ValidationStatus) -> Self {
        Self {
            name: name.into(),
            status,
        }
    }
}

/// A cheap-to-inspect summary of validation: an overall status, per-severity
/// counts, and the named passes that ran.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct ValidationSummary {
    pub status: ValidationStatus,
    pub counts: ValidationCounts,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub passes: Vec<ValidationPass>,
}

impl ValidationSummary {
    /// A clean pass with no findings.
    pub fn ok() -> Self {
        Self {
            status: ValidationStatus::Ok,
            counts: ValidationCounts::default(),
            passes: Vec::new(),
        }
    }

    /// Derive counts and the dominant status from a set of diagnostics.
    pub fn from_diagnostics(diagnostics: &[StructuredDiagnostic]) -> Self {
        let mut counts = ValidationCounts::default();
        let mut status = ValidationStatus::Ok;
        for d in diagnostics {
            counts.add(d.severity);
            status = status.max(ValidationStatus::from_severity(d.severity));
        }
        Self {
            status,
            counts,
            passes: Vec::new(),
        }
    }

    #[must_use]
    pub fn with_passes(mut self, passes: Vec<ValidationPass>) -> Self {
        self.passes = passes;
        self
    }
}