vld 0.7.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
88
89
90
91

//! Helper macros for the generated code.
//!
//! The feature-gate helpers are conditionally compiled based on **vld's**
//! features, so when a foreign crate invokes `vld::schema!`, the check uses
//! vld's features instead of the consumer's — eliminating `unexpected_cfgs`
//! warnings.

/// The schema built by `$schema`, cached process-wide on first use
/// (`&'static`). Only for non-generic code.
#[doc(hidden)]
#[macro_export]
macro_rules! __vld_cached {
    ($schema:expr) => {{
        static __VLD_CELL: $crate::__private::SchemaCell = $crate::__private::SchemaCell::new();
        __VLD_CELL.get(|| $schema)
    }};
}

/// A serde `deserialize_with` function that parses with a vld schema (built
/// once per process).
///
/// `vld::deserialize_fn!(pub fn port -> u16 = vld::u16().min(1));` defines
/// `pub fn port<'de, D: Deserializer<'de>>(d: D) -> Result<u16, D::Error>`.
/// See [`vld::de`](crate::de).
#[macro_export]
macro_rules! deserialize_fn {
    ($(#[$attr:meta])* $vis:vis fn $name:ident -> $ty:ty = $schema:expr $(;)?) => {
        $(#[$attr])*
        $vis fn $name<'de, D>(deserializer: D) -> ::std::result::Result<$ty, D::Error>
        where
            D: $crate::serde::Deserializer<'de>,
        {
            $crate::de::with($crate::__vld_cached!($schema), deserializer)
        }
    };
}

/// Emit the given tokens only when the `openapi` feature is enabled on `vld`.
#[cfg(feature = "openapi")]
#[doc(hidden)]
#[macro_export]
macro_rules! __vld_if_openapi {
    ($($tt:tt)*) => { $($tt)* };
}

/// No-op: `openapi` feature is disabled.
#[cfg(not(feature = "openapi"))]
#[doc(hidden)]
#[macro_export]
macro_rules! __vld_if_openapi {
    ($($tt:tt)*) => {};
}

#[cfg(feature = "openapi")]
#[doc(hidden)]
#[macro_export]
macro_rules! __vld_nested_schema_fn {
    ($ty:ty) => {
        Some(<$ty>::json_schema as fn() -> $crate::serde_json::Value)
    };
}

#[cfg(not(feature = "openapi"))]
#[doc(hidden)]
#[macro_export]
macro_rules! __vld_nested_schema_fn {
    ($ty:ty) => {
        None
    };
}

#[cfg(feature = "openapi")]
#[doc(hidden)]
#[macro_export]
macro_rules! __vld_nested_collect_fn {
    ($ty:ty) => {
        Some(
            <$ty>::__vld_collect_nested_schemas
                as fn(&mut ::std::vec::Vec<$crate::openapi::NestedSchemaEntry>),
        )
    };
}

#[cfg(not(feature = "openapi"))]
#[doc(hidden)]
#[macro_export]
macro_rules! __vld_nested_collect_fn {
    ($ty:ty) => {
        None
    };
}