nominal-api 0.1240.0

API bindings for the Nominal platform
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

/// Result of template validation
#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct ValidationResult {
    #[serde(rename = "valid")]
    valid: bool,
    #[builder(default, into)]
    #[serde(
        rename = "evaluatedPayload",
        skip_serializing_if = "Option::is_none",
        default
    )]
    evaluated_payload: Option<String>,
    #[builder(default, list(item(type = super::ValidationError)))]
    #[serde(rename = "errors", skip_serializing_if = "Vec::is_empty", default)]
    errors: Vec<super::ValidationError>,
    #[builder(default, list(item(type = super::ValidationWarning)))]
    #[serde(rename = "warnings", skip_serializing_if = "Vec::is_empty", default)]
    warnings: Vec<super::ValidationWarning>,
}
impl ValidationResult {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(valid: bool) -> Self {
        Self::builder().valid(valid).build()
    }
    /// Whether the template is syntactically valid and produces valid JSON
    #[inline]
    pub fn valid(&self) -> bool {
        self.valid
    }
    /// Evaluated JSON payload if template is valid
    #[inline]
    pub fn evaluated_payload(&self) -> Option<&str> {
        self.evaluated_payload.as_ref().map(|o| &**o)
    }
    /// List of validation errors
    #[inline]
    pub fn errors(&self) -> &[super::ValidationError] {
        &*self.errors
    }
    /// List of validation warnings
    #[inline]
    pub fn warnings(&self) -> &[super::ValidationWarning] {
        &*self.warnings
    }
}