address 0.2.0

Network address types with strict validation, owned & borrowed variants, and standard library conversions.
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

/// Implements `Serialize` for an owned type that serializes as its `Display` string.
macro_rules! impl_serialize_display {
    ($ty:ident) => {
        impl ::serde::Serialize for crate::$ty {
            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: ::serde::Serializer,
            {
                serializer.collect_str(self)
            }
        }
    };
}

/// Implements `Serialize` for a reference type that serializes as its `Display` string.
macro_rules! impl_serialize_display_ref {
    ($ty:ident) => {
        impl<'a> ::serde::Serialize for crate::$ty<'a> {
            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: ::serde::Serializer,
            {
                serializer.collect_str(self)
            }
        }
    };
}

/// Implements `Deserialize` for an owned type that parses from a string.
macro_rules! impl_deserialize_string {
    ($ty:ident, $expecting:literal) => {
        impl<'de> ::serde::Deserialize<'de> for crate::$ty {
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: ::serde::Deserializer<'de>,
            {
                deserializer.deserialize_string(crate::serde::FromStringVisitor::new($expecting))
            }
        }
    };
}

/// Implements `Deserialize` for a reference type that borrows from the input string.
macro_rules! impl_deserialize_string_ref {
    ($ty:ident, $owned:ident, $expecting:literal) => {
        impl<'de: 'a, 'a> ::serde::Deserialize<'de> for crate::$ty<'a> {
            #[doc = concat!(
                "The string is borrowed from the input, so domain names must be lowercase and ",
                "must not contain escape sequences. Use [`",
                stringify!($owned),
                "`](crate::",
                stringify!($owned),
                ") for normalization or escaped input."
            )]
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: ::serde::Deserializer<'de>,
            {
                deserializer.deserialize_str(crate::serde::TryFromStrVisitor::new($expecting))
            }
        }
    };
}

impl_serialize_display!(Authority);
impl_serialize_display_ref!(AuthorityRef);

impl ::serde::Serialize for crate::Domain {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: ::serde::Serializer,
    {
        serializer.serialize_str(self.name())
    }
}

impl<'a> ::serde::Serialize for crate::DomainRef<'a> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: ::serde::Serializer,
    {
        serializer.serialize_str(self.name())
    }
}

impl_serialize_display!(Endpoint);
impl_serialize_display_ref!(EndpointRef);

impl ::serde::Serialize for crate::Host {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: ::serde::Serializer,
    {
        match self {
            Self::Domain(domain) => serializer.serialize_str(domain.name()),
            Self::IPAddress(ip) => serializer.collect_str(ip),
        }
    }
}

impl<'a> ::serde::Serialize for crate::HostRef<'a> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: ::serde::Serializer,
    {
        match self {
            Self::Domain(domain) => serializer.serialize_str(domain.name()),
            Self::IPAddress(ip) => serializer.collect_str(ip),
        }
    }
}

impl_deserialize_string!(Authority, "an authority string");
impl_deserialize_string_ref!(AuthorityRef, Authority, "a borrowed authority string");

impl_deserialize_string!(Domain, "a domain string");
impl_deserialize_string_ref!(DomainRef, Domain, "a borrowed domain string");

impl_deserialize_string!(Endpoint, "an endpoint string");
impl_deserialize_string_ref!(EndpointRef, Endpoint, "a borrowed endpoint string");

impl_deserialize_string!(Host, "a host string");
impl_deserialize_string_ref!(HostRef, Host, "a borrowed host string");

#[cfg(test)]
mod tests {
    use crate::serde::test_util::{assert_json, assert_postcard};
    use crate::{
        Authority, AuthorityRef, Domain, DomainRef, Endpoint, EndpointRef, Host, HostRef,
        IPv4Address, IPv6Address,
    };

    #[test]
    fn json() {
        assert_json(Domain::localhost(), "\"localhost\"");
        assert_json(Domain::example(), "\"example.com\"");
        assert_json(Domain::localhost().to_endpoint(80), "\"localhost:80\"");
        assert_json(Domain::localhost().to_host(), "\"localhost\"");
        assert_json(IPv4Address::LOCALHOST.to_host(), "\"127.0.0.1\"");
        assert_json(
            Domain::localhost().to_host().to_authority(80),
            "\"localhost:80\"",
        );
        assert_json(
            IPv6Address::LOCALHOST.to_host().to_authority(80),
            "\"[::1]:80\"",
        );
    }

    #[test]
    fn postcard() {
        let bytes: Vec<u8> = assert_postcard(Domain::localhost());
        assert_eq!(bytes.len(), 10, "a length prefix plus the 9 name bytes");

        assert_postcard(Domain::example().to_endpoint(443));
        assert_postcard(Domain::example().to_host());
        assert_postcard(IPv4Address::LOCALHOST.to_host().to_authority(80));
    }

    #[test]
    fn borrowed_refs() {
        let json: &str = "\"localhost\"";
        let domain: DomainRef = serde_json::from_str(json).unwrap();
        assert_eq!(domain, DomainRef::LOCALHOST);
        assert_eq!(serde_json::to_string(&domain).unwrap(), json);

        let json: &str = "\"localhost:80\"";
        let endpoint: EndpointRef = serde_json::from_str(json).unwrap();
        assert_eq!(endpoint, EndpointRef::new(DomainRef::LOCALHOST, 80));
        assert_eq!(serde_json::to_string(&endpoint).unwrap(), json);

        let json: &str = "\"127.0.0.1\"";
        let host: HostRef = serde_json::from_str(json).unwrap();
        assert_eq!(host, IPv4Address::LOCALHOST.to_host_ref());
        assert_eq!(serde_json::to_string(&host).unwrap(), json);

        let json: &str = "\"[::1]:443\"";
        let authority: AuthorityRef = serde_json::from_str(json).unwrap();
        assert_eq!(
            authority,
            IPv6Address::LOCALHOST.to_host_ref().to_authority_ref(443)
        );
        assert_eq!(serde_json::to_string(&authority).unwrap(), json);
    }

    #[test]
    fn mixed_case() {
        let domain: Domain = serde_json::from_str("\"LocalHost\"").unwrap();
        assert_eq!(domain, Domain::localhost());

        let authority: Authority = serde_json::from_str("\"LocalHost:80\"").unwrap();
        assert_eq!(authority, Domain::localhost().to_host().to_authority(80));

        assert!(serde_json::from_str::<DomainRef>("\"LocalHost\"").is_err());
        assert!(serde_json::from_str::<AuthorityRef>("\"LocalHost:80\"").is_err());
    }

    #[test]
    fn escaped_input() {
        let json: &str = "\"local\\u0068ost\"";

        let domain: Domain = serde_json::from_str(json).unwrap();
        assert_eq!(domain, Domain::localhost());

        let host: Host = serde_json::from_str(json).unwrap();
        assert_eq!(host, Domain::localhost().to_host());

        assert!(serde_json::from_str::<DomainRef>(json).is_err());
        assert!(serde_json::from_str::<HostRef>(json).is_err());
    }

    #[test]
    fn invalid_input() {
        assert!(serde_json::from_str::<Domain>("\"Local!Host\"").is_err());
        assert!(serde_json::from_str::<Endpoint>("\"localhost\"").is_err());
        assert!(serde_json::from_str::<Authority>("\"::1:80\"").is_err());
        assert!(serde_json::from_str::<Domain>("42").is_err());
    }

    #[test]
    fn expecting_message() {
        let error: String = serde_json::from_str::<Domain>("42")
            .unwrap_err()
            .to_string();
        assert!(error.contains("a domain string"), "error={}", error);

        let error: String = serde_json::from_str::<AuthorityRef>("42")
            .unwrap_err()
            .to_string();
        assert!(
            error.contains("a borrowed authority string"),
            "error={}",
            error
        );
    }
}