vld 0.5.1

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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use serde_json::Value;
use std::net::SocketAddr;

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

/// Schema for socket addresses (`ipv4:port` / `[ipv6]:port`; hostnames are
/// rejected). Created via [`vld::socket_addr()`](crate::socket_addr).
#[derive(Clone)]
pub struct ZSocketAddr {
    min_port: Option<u16>,
    max_port: Option<u16>,
    custom_type_error: Option<String>,
}

impl ZSocketAddr {
    /// Create the schema (the same as its `vld::` constructor function).
    pub fn new() -> Self {
        Self {
            min_port: None,
            max_port: None,
            custom_type_error: None,
        }
    }

    /// Message used when the input is not a string.
    pub fn type_error(mut self, msg: impl Into<String>) -> Self {
        self.custom_type_error = Some(msg.into());
        self
    }

    /// Port must be at least `p`.
    pub fn min_port(mut self, p: u16) -> Self {
        self.min_port = Some(p);
        self
    }

    /// Port must be at most `p`.
    pub fn max_port(mut self, p: u16) -> Self {
        self.max_port = Some(p);
        self
    }
}

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

impl VldSchema for ZSocketAddr {
    type Output = SocketAddr;

    fn parse_value(&self, value: &Value) -> Result<Self::Output, VldError> {
        let s = value.as_str().ok_or_else(|| {
            crate::primitives::type_error(&self.custom_type_error, "socket_addr", value)
        })?;
        let addr = s.parse::<SocketAddr>().map_err(|_| {
            VldError::from_code_with_value(
                IssueCode::InvalidFormat {
                    format: FormatKind::SocketAddr,
                },
                value,
            )
        })?;
        let port = addr.port();
        if let Some(min) = self.min_port {
            if port < min {
                return Err(VldError::from_code_with_value(
                    IssueCode::TooSmall {
                        origin: SizeOrigin::Port,
                        minimum: min.into(),
                        inclusive: true,
                    },
                    value,
                ));
            }
        }
        if let Some(max) = self.max_port {
            if port > max {
                return Err(VldError::from_code_with_value(
                    IssueCode::TooBig {
                        origin: SizeOrigin::Port,
                        maximum: max.into(),
                        inclusive: true,
                    },
                    value,
                ));
            }
        }
        Ok(addr)
    }
}

#[cfg(feature = "openapi")]
impl crate::openapi::JsonSchema for ZSocketAddr {
    fn json_schema(&self) -> serde_json::Value {
        serde_json::json!({
            "type": "string",
            "format": "socket-addr"
        })
    }
}

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