shrike 0.1.1

AT Protocol library for Rust
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

use std::fmt;

/// Errors that can occur when parsing or managing Lexicon schemas.
#[derive(Debug, thiserror::Error)]
pub enum LexiconError {
    #[error("invalid schema: {0}")]
    InvalidSchema(String),

    #[error("JSON parse error: {0}")]
    Json(#[from] serde_json::Error),
}

/// Top-level validation error.
#[derive(Debug)]
pub enum ValidationError {
    /// A field-level error with a path into the document.
    Field {
        path: String,
        kind: ValidationErrorKind,
    },

    /// The collection NSID was not found in the catalog.
    UnknownCollection(String),

    /// A schema-level inconsistency prevented validation.
    Schema(String),

    /// Multiple validation errors were found.
    Multiple(Vec<ValidationError>),
}

impl fmt::Display for ValidationError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ValidationError::Field { path, kind } => write!(f, "at {path}: {kind}"),
            ValidationError::UnknownCollection(nsid) => write!(f, "unknown collection: {nsid}"),
            ValidationError::Schema(msg) => write!(f, "schema error: {msg}"),
            ValidationError::Multiple(errs) => {
                for (i, e) in errs.iter().enumerate() {
                    if i > 0 {
                        writeln!(f)?;
                    }
                    write!(f, "{e}")?;
                }
                Ok(())
            }
        }
    }
}

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

/// The specific kind of a field validation failure.
#[derive(Debug, thiserror::Error)]
pub enum ValidationErrorKind {
    #[error("required field missing")]
    Required,

    #[error("expected {expected}, got {got}")]
    TypeMismatch { expected: String, got: String },

    #[error("string too short: min {min}, got {got}")]
    TooShort { min: u64, got: u64 },

    #[error("string too long: max {max}, got {got}")]
    TooLong { max: u64, got: u64 },

    #[error("integer out of range")]
    OutOfRange,

    #[error("value not in enum: {got}")]
    InvalidEnum { got: String },

    #[error("{0}")]
    Other(String),
}