rsntp 4.1.1

An RFC 5905 compliant Simple Network Time Protocol (SNTP) client library for Rust
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

use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6};

/// A trait for objects which can be converted or resolved to one or more SocketAddr values with or
/// without a port.
///
/// This trait is similar to the `std::net::ToSocketAddrs` trait, but the port is optional.
/// If no port is supplied then the user of this trait falls back to a default one.
///
/// It is implemented for almost all types `ToSocketAddrs` is implemented for, plus for some addition types
/// where the optional port is not present (`(IpAddr, u16)`, and also for simple `IpAddr`). For string
/// implementation, the port is also optional, so both `<host>:<port>` and `<host>` can be used.
///
/// The trait is intended to be opaque; details might change.
///
/// # Examples
///
/// ```no_run
/// use rsntp::ToServerAddrs;
/// use std::net::Ipv4Addr;
///
/// fn connect<A: ToServerAddrs>(addr: A) {
///   // connect to a server with default port 1234
/// }
///
/// connect("127.0.0.1"); // will connect to 127.0.0.1:1234
/// connect("127.0.0.1:456"); // will connect to 127.0.0.1:456
///
/// connect(Ipv4Addr::new(127, 0, 0, 1)); // will connect to 127.0.0.1:1234
/// connect((Ipv4Addr::new(127, 0, 0, 1), 456)); // will connect to 127.0.0.1:456
///
/// ```
pub trait ToServerAddrs {
    #[cfg(feature = "async")]
    #[doc(hidden)]
    type Return: std::net::ToSocketAddrs + tokio::net::ToSocketAddrs;
    #[cfg(not(feature = "async"))]
    #[doc(hidden)]
    type Return: std::net::ToSocketAddrs;

    #[doc(hidden)]
    fn to_server_addrs(&self, default_port: u16) -> Self::Return;
}

impl ToServerAddrs for SocketAddr {
    type Return = SocketAddr;

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        *self
    }
}

impl ToServerAddrs for SocketAddrV4 {
    type Return = SocketAddrV4;

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        *self
    }
}

impl ToServerAddrs for SocketAddrV6 {
    type Return = SocketAddrV6;

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        *self
    }
}

impl ToServerAddrs for IpAddr {
    type Return = (IpAddr, u16);

    fn to_server_addrs(&self, default_port: u16) -> Self::Return {
        (*self, default_port)
    }
}

impl ToServerAddrs for (IpAddr, u16) {
    type Return = (IpAddr, u16);

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        *self
    }
}

impl ToServerAddrs for Ipv4Addr {
    type Return = (Ipv4Addr, u16);

    fn to_server_addrs(&self, default_port: u16) -> Self::Return {
        (*self, default_port)
    }
}

impl ToServerAddrs for (Ipv4Addr, u16) {
    type Return = (Ipv4Addr, u16);

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        *self
    }
}

impl ToServerAddrs for Ipv6Addr {
    type Return = (Ipv6Addr, u16);

    fn to_server_addrs(&self, default_port: u16) -> Self::Return {
        (*self, default_port)
    }
}

impl ToServerAddrs for (Ipv6Addr, u16) {
    type Return = (Ipv6Addr, u16);

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        *self
    }
}

impl ToServerAddrs for str {
    type Return = String;

    fn to_server_addrs(&self, default_port: u16) -> Self::Return {
        if self.parse::<Ipv4Addr>().is_ok() {
            self.to_string() + ":" + &default_port.to_string()
        } else if self.parse::<Ipv6Addr>().is_ok() {
            "[".to_string() + self + "]:" + &default_port.to_string()
        } else if self.starts_with("[") && self.ends_with("]") {
            // probably an IPv6 address between [ and ]
            self.to_string() + ":" + &default_port.to_string()
        } else if !self.contains(":") {
            self.to_string() + ":" + &default_port.to_string()
        } else {
            self.to_string()
        }
    }
}

impl ToServerAddrs for String {
    type Return = String;

    fn to_server_addrs(&self, default_port: u16) -> Self::Return {
        (**self).to_server_addrs(default_port)
    }
}

impl<'a> ToServerAddrs for (&'a str, u16) {
    type Return = (&'a str, u16);

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        *self
    }
}

impl ToServerAddrs for (String, u16) {
    type Return = String;

    fn to_server_addrs(&self, _default_port: u16) -> Self::Return {
        self.0.clone() + ":" + &self.1.to_string()
    }
}

impl<T: ToServerAddrs + ?Sized> ToServerAddrs for &T {
    type Return = T::Return;

    fn to_server_addrs(&self, default_port: u16) -> Self::Return {
        (**self).to_server_addrs(default_port)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn works_for_socket_addr() {
        let s = SocketAddr::from(([127, 0, 0, 1], 1234));
        let s4 = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 1234);
        let s6 = SocketAddrV6::new(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1), 1234, 0, 0);

        assert_eq!(s.to_server_addrs(456), s);
        assert_eq!(s4.to_server_addrs(456), s4);
        assert_eq!(s6.to_server_addrs(456), s6);
    }

    #[test]
    fn works_for_ip_addr() {
        let ip = IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1));
        let ip4 = Ipv4Addr::new(127, 0, 0, 1);
        let ip6 = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1);

        assert_eq!(ip.to_server_addrs(456), (ip, 456));
        assert_eq!(ip4.to_server_addrs(456), (ip4, 456));
        assert_eq!(ip6.to_server_addrs(456), (ip6, 456));

        assert_eq!((ip, 1234).to_server_addrs(456), (ip, 1234));
        assert_eq!((ip4, 1234).to_server_addrs(456), (ip4, 1234));
        assert_eq!((ip6, 1234).to_server_addrs(456), (ip6, 1234));
    }

    #[test]
    fn works_for_ipv4_strings() {
        assert_eq!("127.0.0.1".to_server_addrs(456), "127.0.0.1:456");
        assert_eq!("127.0.0.1:1234".to_server_addrs(456), "127.0.0.1:1234");
        assert_eq!(
            "127.0.0.1".to_string().to_server_addrs(456),
            "127.0.0.1:456"
        );
        assert_eq!(
            "127.0.0.1:1234".to_string().to_server_addrs(456),
            "127.0.0.1:1234"
        );

        assert_eq!(
            ("127.0.0.1", 1234).to_server_addrs(456),
            ("127.0.0.1", 1234)
        );

        assert_eq!(
            ("127.0.0.1".to_string(), 1234).to_server_addrs(456),
            "127.0.0.1:1234"
        );
    }

    #[test]
    fn works_for_ip6_string() {
        assert_eq!("::1".to_server_addrs(456), "[::1]:456");
        assert_eq!("[::1]".to_server_addrs(456), "[::1]:456");
        assert_eq!("[::1]:1234".to_server_addrs(456), "[::1]:1234");

        assert_eq!("::1".to_string().to_server_addrs(456), "[::1]:456");
        assert_eq!("[::1]".to_string().to_server_addrs(456), "[::1]:456");
        assert_eq!("[::1]:1234".to_string().to_server_addrs(456), "[::1]:1234");
    }
}