vld 0.3.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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use serde_json::Value;

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

/// Schema for boolean validation. Created via [`vld::boolean()`](crate::boolean).
#[derive(Clone)]
pub struct ZBoolean {
    coerce: bool,
}

impl ZBoolean {
    pub fn new() -> Self {
        Self { coerce: false }
    }

    /// Coerce truthy/falsy values to booleans.
    ///
    /// Accepted coercions:
    /// - Strings: `"true"`, `"1"` → `true`; `"false"`, `"0"` → `false`
    /// - Numbers: `0` → `false`; anything else → `true`
    pub fn coerce(mut self) -> Self {
        self.coerce = true;
        self
    }
}

impl Default for ZBoolean {
    fn default() -> Self {
        Self::new()
    }
}

impl ZBoolean {
    /// Generate a JSON Schema representation.
    ///
    /// Requires the `openapi` feature.
    #[cfg(feature = "openapi")]
    pub fn to_json_schema(&self) -> serde_json::Value {
        serde_json::json!({"type": "boolean"})
    }
}

impl VldSchema for ZBoolean {
    type Output = bool;

    fn parse_value(&self, value: &Value) -> Result<bool, VldError> {
        if let Some(b) = value.as_bool() {
            return Ok(b);
        }

        if self.coerce {
            match value {
                Value::String(s) => match s.as_str() {
                    "true" | "1" => Ok(true),
                    "false" | "0" => Ok(false),
                    _ => Err(VldError::single_with_value(
                        IssueCode::InvalidType {
                            expected: "boolean".into(),
                            received: "string".into(),
                        },
                        format!("Cannot coerce \"{}\" to boolean", s),
                        value,
                    )),
                },
                Value::Number(n) => Ok(n.as_f64() != Some(0.0)),
                _ => Err(VldError::single_with_value(
                    IssueCode::InvalidType {
                        expected: "boolean".into(),
                        received: value_type_name(value),
                    },
                    format!("Expected boolean, received {}", value_type_name(value)),
                    value,
                )),
            }
        } else {
            Err(VldError::single_with_value(
                IssueCode::InvalidType {
                    expected: "boolean".into(),
                    received: value_type_name(value),
                },
                format!("Expected boolean, received {}", value_type_name(value)),
                value,
            ))
        }
    }
}