wyvern-schema 0.4.0

Wyvern JSON types, validation, and error messages
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

//! Validation-stage errors for schema checking.

use crate::error_code::ErrorCode;
use crate::field_name::FieldName;

/// Failure while validating command JSON against the phase surface.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ValidationError {
    /// Schema or field-level validation failure.
    Validation { field: FieldName, message: String },
    /// Mode/lifecycle state failure (e.g. action outside `--interactive`).
    State { field: FieldName, message: String },
}

impl std::fmt::Display for ValidationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Validation { field, message } => {
                write!(f, "validation error ({field}): {message}")
            }
            Self::State { field, message } => write!(f, "state error ({field}): {message}"),
        }
    }
}

impl std::error::Error for ValidationError {}

impl ValidationError {
    /// Build a schema validation error for `field`.
    pub(crate) fn validation(field: impl Into<FieldName>, message: impl Into<String>) -> Self {
        Self::Validation {
            field: field.into(),
            message: message.into(),
        }
    }

    /// Build a state error for `field`.
    pub(crate) fn state(field: impl Into<FieldName>, message: impl Into<String>) -> Self {
        Self::State {
            field: field.into(),
            message: message.into(),
        }
    }

    /// Stable exit code for this validation failure.
    pub fn exit_code(&self) -> i32 {
        match self {
            Self::Validation { .. } => ErrorCode::ValidationError.exit_code(),
            Self::State { .. } => ErrorCode::StateError.exit_code(),
        }
    }
}