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

use crate::serde::FromStrVisitor;
use crate::{IPAddress, IPv4Address, IPv6Address};
use serde::de::{Error, SeqAccess, Visitor};
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::fmt::Formatter;

impl Serialize for IPAddress {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        if serializer.is_human_readable() {
            serializer.collect_str(self)
        } else {
            serializer.serialize_bytes(self.address())
        }
    }
}

struct IPAddressBytesVisitor;

impl<'de> Visitor<'de> for IPAddressBytesVisitor {
    type Value = IPAddress;

    fn expecting(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str("a 4 or 16 byte IP address")
    }

    fn visit_bytes<E>(self, v: &[u8]) -> Result<Self::Value, E>
    where
        E: Error,
    {
        if let Ok(address) = <[u8; 4]>::try_from(v) {
            Ok(IPv4Address::new(address).to_ip())
        } else if let Ok(address) = <[u8; 16]>::try_from(v) {
            Ok(IPv6Address::new(address).to_ip())
        } else {
            Err(E::invalid_length(v.len(), &self))
        }
    }

    fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
    where
        A: SeqAccess<'de>,
    {
        let mut address: [u8; 16] = [0; 16];
        let mut len: usize = 0;
        while let Some(byte) = seq.next_element::<u8>()? {
            if len == address.len() {
                return Err(A::Error::invalid_length(len + 1, &self));
            }
            address[len] = byte;
            len += 1;
        }
        self.visit_bytes(&address[..len])
    }
}

impl<'de> Deserialize<'de> for IPAddress {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        if deserializer.is_human_readable() {
            deserializer.deserialize_str(FromStrVisitor::new("an IP address string"))
        } else {
            deserializer.deserialize_bytes(IPAddressBytesVisitor)
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::serde::ip_address::IPAddressBytesVisitor;
    use crate::serde::test_util::{assert_json, assert_postcard};
    use crate::{IPAddress, IPv4Address, IPv6Address};
    use serde::Deserializer;
    use serde::de::value::{Error as ValueError, SeqDeserializer};

    #[test]
    fn json() {
        assert_json(IPv4Address::LOCALHOST.to_ip(), "\"127.0.0.1\"");
        assert_json(IPv6Address::LOCALHOST.to_ip(), "\"::1\"");
        assert_json(IPv4Address::BROADCAST.to_ip(), "\"255.255.255.255\"");
    }

    #[test]
    fn postcard() {
        let bytes: Vec<u8> = assert_postcard(IPv4Address::LOCALHOST.to_ip());
        assert_eq!(bytes.len(), 5, "a length prefix plus 4 address bytes");

        let bytes: Vec<u8> = assert_postcard(IPv6Address::LOCALHOST.to_ip());
        assert_eq!(bytes.len(), 17, "a length prefix plus 16 address bytes");
    }

    #[test]
    fn visit_seq() {
        let test_cases: &[(&[u8], Option<IPAddress>)] = &[
            (&[127, 0, 0, 1], Some(IPv4Address::LOCALHOST.to_ip())),
            (&[0; 16], Some(IPv6Address::UNSPECIFIED.to_ip())),
            (&[], None),
            (&[127, 0, 0], None),
            (&[0; 5], None),
            (&[0; 17], None),
        ];

        for (input, expected) in test_cases {
            let seq: SeqDeserializer<_, ValueError> = SeqDeserializer::new(input.iter().copied());
            let result: Option<IPAddress> = seq.deserialize_seq(IPAddressBytesVisitor).ok();
            assert_eq!(result, *expected, "input={:?}", input);
        }
    }
}