vld 0.6.0

Type-safe runtime validation library for Rust, inspired by Zod
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

use serde_json::Value;

use crate::error::{IssueCode, SizeOrigin, VldError};
use crate::schema::VldSchema;

/// Schema for a single `char`: a JSON string of exactly one Unicode scalar
/// value. Created via [`vld::char()`](crate::char).
///
/// # Example
/// ```
/// use vld::prelude::*;
///
/// assert_eq!(vld::char().parse(r#""é""#).unwrap(), 'é');
/// assert!(vld::char().parse(r#""ab""#).is_err());
/// assert!(vld::char().parse(r#""""#).is_err());
/// ```
#[derive(Clone, Default)]
pub struct ZChar {
    custom_type_error: Option<String>,
}

impl ZChar {
    /// Create the schema (the same as its `vld::` constructor function).
    pub fn new() -> Self {
        Self::default()
    }

    /// Set a custom error message for type mismatch (non-string input).
    pub fn type_error(mut self, msg: impl Into<String>) -> Self {
        self.custom_type_error = Some(msg.into());
        self
    }
}

impl VldSchema for ZChar {
    type Output = char;

    fn parse_value(&self, value: &Value) -> Result<char, VldError> {
        let s = value.as_str().ok_or_else(|| {
            crate::primitives::type_error(&self.custom_type_error, "string", value)
        })?;
        let mut chars = s.chars();
        match (chars.next(), chars.next()) {
            (Some(c), None) => Ok(c),
            _ => Err(VldError::from_code_with_value(
                IssueCode::InvalidLength {
                    origin: SizeOrigin::String,
                    expected: 1,
                },
                value,
            )),
        }
    }
}

/// `{"type": "string", "minLength": 1, "maxLength": 1}`.
#[cfg(feature = "openapi")]
impl crate::openapi::JsonSchema for ZChar {
    fn json_schema(&self) -> Value {
        serde_json::json!({"type": "string", "minLength": 1, "maxLength": 1})
    }
}

#[cfg(feature = "openapi")]
impl crate::openapi::CollectNestedSchemas for ZChar {}