odcs 0.8.0

Reference implementation of the Open Data Contract Standard (ODCS)
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

//! A single diagnostic message.

use super::{DiagnosticCategory, DiagnosticStage, Severity, ValidationPhase};

/// A spec-level diagnostic record.
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct Diagnostic {
    /// Stable `odcs:` diagnostic identifier.
    pub id: String,
    /// Diagnostic severity.
    pub severity: Severity,
    /// Originating processing stage.
    pub stage: DiagnosticStage,
    /// Diagnostic category.
    pub category: DiagnosticCategory,
    /// Human-readable message.
    pub message: String,
    /// Affected object reference, when applicable.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub object_ref: Option<String>,
    /// Suggested remediation, when practical.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub remediation: Option<String>,
    /// Validation pipeline phase that produced this diagnostic.
    #[serde(rename = "validationPhase", skip_serializing_if = "Option::is_none")]
    pub validation_phase: Option<ValidationPhase>,
}

impl Diagnostic {
    /// Creates a new diagnostic.
    #[must_use]
    pub fn new(
        id: impl Into<String>,
        severity: Severity,
        stage: DiagnosticStage,
        category: DiagnosticCategory,
        message: impl Into<String>,
    ) -> Self {
        Self {
            id: id.into(),
            severity,
            stage,
            category,
            message: message.into(),
            object_ref: None,
            remediation: None,
            validation_phase: None,
        }
    }

    /// Creates an error-level diagnostic.
    #[must_use]
    pub fn error(
        id: impl Into<String>,
        category: DiagnosticCategory,
        stage: DiagnosticStage,
        message: impl Into<String>,
    ) -> Self {
        Self::new(id, Severity::Error, stage, category, message)
    }

    /// Sets the affected object reference.
    #[must_use]
    pub fn with_object_ref(mut self, object_ref: impl Into<String>) -> Self {
        self.object_ref = Some(object_ref.into());
        self
    }

    /// Sets remediation guidance.
    #[must_use]
    pub fn with_remediation(mut self, remediation: impl Into<String>) -> Self {
        self.remediation = Some(remediation.into());
        self
    }

    /// Sets the validation pipeline phase.
    #[must_use]
    pub fn with_validation_phase(mut self, phase: ValidationPhase) -> Self {
        self.validation_phase = Some(phase);
        self
    }
}