phoxal 0.42.3

Phoxal - production-oriented autonomous robot framework: the runtime engine and model (the api contract tree lives in phoxal-api, the typed bus in phoxal-bus).
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ConformanceStatus {
    Pass,
    Fail,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConformanceReport {
    pub status: ConformanceStatus,
    pub evidence: Vec<ConformanceEvidence>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub failures: Vec<ConformanceFailure>,
}

impl ConformanceReport {
    #[must_use]
    pub fn pass(evidence: Vec<ConformanceEvidence>) -> Self {
        Self {
            status: ConformanceStatus::Pass,
            evidence,
            failures: Vec::new(),
        }
    }

    #[must_use]
    pub fn fail(evidence: Vec<ConformanceEvidence>, failures: Vec<ConformanceFailure>) -> Self {
        Self {
            status: ConformanceStatus::Fail,
            evidence,
            failures,
        }
    }

    #[must_use]
    pub fn is_pass(&self) -> bool {
        matches!(self.status, ConformanceStatus::Pass)
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConformanceEvidence {
    pub check: String,
    pub detail: String,
}

impl ConformanceEvidence {
    #[must_use]
    pub fn new(check: impl Into<String>, detail: impl Into<String>) -> Self {
        Self {
            check: check.into(),
            detail: detail.into(),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConformanceFailure {
    pub check: String,
    pub reason: String,
}

impl ConformanceFailure {
    #[must_use]
    pub fn new(check: impl Into<String>, reason: impl Into<String>) -> Self {
        Self {
            check: check.into(),
            reason: reason.into(),
        }
    }
}