schemars 1.2.1

Generate JSON Schemas from Rust code
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use crate::SchemaGenerator;
use crate::_alloc_prelude::*;
use crate::{json_schema, JsonSchema, Schema};
use alloc::borrow::Cow;

macro_rules! simple_impl {
    ($type:ty => $instance_type:literal) => {
        impl JsonSchema for $type {
            inline_schema!();

            fn schema_name() -> Cow<'static, str> {
                $instance_type.into()
            }

            fn json_schema(_: &mut SchemaGenerator) -> Schema {
                json_schema!({
                    "type": $instance_type
                })
            }
        }
    };
    ($type:ty => $instance_type:literal, $format:literal) => {
        impl JsonSchema for $type {
            inline_schema!();

            fn schema_name() -> Cow<'static, str> {
                $format.into()
            }

            fn json_schema(_: &mut SchemaGenerator) -> Schema {
                json_schema!({
                    "type": $instance_type,
                    "format": $format
                })
            }
        }
    };
}

macro_rules! ranged_impl {
    ($type:ty => $instance_type:literal, $format:literal) => {
        impl JsonSchema for $type {
            inline_schema!();

            fn schema_name() -> Cow<'static, str> {
                $format.into()
            }

            fn json_schema(_: &mut SchemaGenerator) -> Schema {
                json_schema!({
                    "type": $instance_type,
                    "format": $format,
                    "minimum": <$type>::MIN,
                    "maximum": <$type>::MAX
                })
            }
        }
    };
}

simple_impl!(str => "string");
simple_impl!(String => "string");
simple_impl!(bool => "boolean");
simple_impl!(f32 => "number", "float");
simple_impl!(f64 => "number", "double");
ranged_impl!(i8 => "integer", "int8");
ranged_impl!(i16 => "integer", "int16");
simple_impl!(i32 => "integer", "int32");
simple_impl!(i64 => "integer", "int64");
simple_impl!(i128 => "integer", "int128");
simple_impl!(isize => "integer", "int");
simple_impl!(() => "null");

#[cfg(feature = "std")]
mod std_types {
    use super::*;
    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6};
    use std::path::{Path, PathBuf};

    simple_impl!(Path => "string");
    simple_impl!(PathBuf => "string");

    simple_impl!(Ipv4Addr => "string", "ipv4");
    simple_impl!(Ipv6Addr => "string", "ipv6");
    simple_impl!(IpAddr => "string", "ip");

    simple_impl!(SocketAddr => "string");
    simple_impl!(SocketAddrV4 => "string");
    simple_impl!(SocketAddrV6 => "string");
}

macro_rules! unsigned_impl {
    ($type:ty => $instance_type:literal, $format:literal) => {
        impl JsonSchema for $type {
            inline_schema!();

            fn schema_name() -> Cow<'static, str> {
                $format.into()
            }

            fn json_schema(_: &mut SchemaGenerator) -> Schema {
                json_schema!({
                    "type": $instance_type,
                    "format": $format,
                    "minimum": 0
                })
            }
        }
    };
}

ranged_impl!(u8 => "integer", "uint8");
ranged_impl!(u16 => "integer", "uint16");
unsigned_impl!(u32 => "integer", "uint32");
unsigned_impl!(u64 => "integer", "uint64");
unsigned_impl!(u128 => "integer", "uint128");
unsigned_impl!(usize => "integer", "uint");

impl JsonSchema for char {
    inline_schema!();

    fn schema_name() -> Cow<'static, str> {
        "Character".into()
    }

    fn schema_id() -> Cow<'static, str> {
        "char".into()
    }

    fn json_schema(_: &mut SchemaGenerator) -> Schema {
        json_schema!({
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
        })
    }
}