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
66
67

//! [`JsonSchema`] / [`CollectNestedSchemas`] impls for the modifiers.

use serde_json::Value;

use crate::openapi::{JsonSchema, nullable_schema};
use crate::schema::VldSchema;

crate::openapi::collect_inner_schemas! {
    impl[S] crate::modifiers::ZOptional<S>, inner = S;
    impl[S] crate::modifiers::ZNullable<S>, inner = S;
    impl[S] crate::modifiers::ZNullish<S>, inner = S;
    impl[S] crate::modifiers::ZDefault<S>, inner = S, where [S::Output: Clone];
}

/// May be left out; `null` is not part of the schema (TypeScript `x?: T`),
/// although parsing tolerates it (serde writes `None` as `null`).
impl<S: VldSchema + JsonSchema> JsonSchema for crate::modifiers::ZOptional<S> {
    fn json_schema(&self) -> Value {
        self.inner_schema().json_schema()
    }
    fn is_required(&self) -> bool {
        false
    }
}

/// The key is required and `null` is allowed (TypeScript `x: T | null`).
impl<S: VldSchema + JsonSchema> JsonSchema for crate::modifiers::ZNullable<S> {
    fn json_schema(&self) -> Value {
        nullable_schema(self.inner_schema().json_schema())
    }
    fn is_required(&self) -> bool {
        true
    }
}

/// May be left out or `null` (TypeScript `x?: T | null`).
impl<S: VldSchema + JsonSchema> JsonSchema for crate::modifiers::ZNullish<S> {
    fn json_schema(&self) -> Value {
        nullable_schema(self.inner_schema().json_schema())
    }
    fn is_required(&self) -> bool {
        false
    }
}

impl<S: VldSchema + JsonSchema> JsonSchema for crate::modifiers::ZDefault<S>
where
    S::Output: Clone + serde::Serialize,
{
    fn json_schema(&self) -> Value {
        let mut schema = self.inner_schema().json_schema();
        // Wrappers forward `output_json`, so a date schema under `describe`
        // & co. still yields its RFC 3339 form.
        let default = self
            .inner_schema()
            .output_json(self.default_value())
            .map(Ok)
            .unwrap_or_else(|| serde_json::to_value(self.default_value()));
        if let (Some(obj), Ok(default)) = (schema.as_object_mut(), default) {
            obj.insert("default".to_string(), default);
        }
        schema
    }
    fn is_required(&self) -> bool {
        false
    }
}