Mercurial > crates > systemd-socket
annotate src/lib.rs @ 22:f33e2c048104
Enable `doc_auto_cfg` in docs.rs builds
| author | Martin Habovstiak <martin.habovstiak@gmail.com> |
|---|---|
| date | Sat, 13 Jul 2024 15:13:21 +0200 |
| parents | f6334887e3c8 |
| children | 1941e9d9819c |
| rev | line source |
|---|---|
| 0 | 1 //! A convenience crate for optionally supporting systemd socket activation. |
| 2 //! | |
| 3 //! ## About | |
| 4 //! | |
| 5 //! The goal of this crate is to make socket activation with systemd in your project trivial. | |
| 6 //! It provides a replacement for `std::net::SocketAddr` that allows parsing the bind address from string just like the one from `std` | |
| 7 //! but on top of that also allows `systemd://socket_name` format that tells it to use systemd activation with given socket name. | |
| 8 //! Then it provides a method to bind the address which will return the socket from systemd if available. | |
| 9 //! | |
| 10 //! The provided type supports conversions from various types of strings and also `serde` and `parse_arg` via feature flag. | |
| 11 //! Thanks to this the change to your code should be minimal - parsing will continue to work, it'll just allow a new format. | |
| 12 //! You only need to change the code to use `SocketAddr::bind()` instead of `TcpListener::bind()` for binding. | |
| 13 //! | |
|
6
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
14 //! You also don't need to worry about conditional compilation to ensure OS compatibility. |
|
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
15 //! This crate handles that for you by disabling systemd on non-linux systems. |
|
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
16 //! |
|
21
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
17 //! Further, the crate also provides methods for binding `tokio` 1.0, 0.2, 0.3, and `async_std` sockets if the appropriate features are |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
18 //! activated. |
| 0 | 19 //! |
| 20 //! ## Example | |
| 21 //! | |
| 22 //! ```no_run | |
| 23 //! use systemd_socket::SocketAddr; | |
| 24 //! use std::convert::TryFrom; | |
| 25 //! use std::io::Write; | |
| 26 //! | |
| 27 //! let mut args = std::env::args_os(); | |
| 28 //! let program_name = args.next().expect("unknown program name"); | |
| 29 //! let socket_addr = args.next().expect("missing socket address"); | |
| 30 //! let socket_addr = SocketAddr::try_from(socket_addr).expect("failed to parse socket address"); | |
| 31 //! let socket = socket_addr.bind().expect("failed to bind socket"); | |
| 32 //! | |
| 33 //! loop { | |
| 34 //! let _ = socket | |
| 35 //! .accept() | |
| 36 //! .expect("failed to accept connection") | |
| 37 //! .0 | |
| 38 //! .write_all(b"Hello world!") | |
| 39 //! .map_err(|err| eprintln!("Failed to send {}", err)); | |
| 40 //! } | |
| 41 //! ``` | |
| 42 //! | |
| 43 //! ## Features | |
| 44 //! | |
|
13
f740dadd2948
Added enable_systemd feature
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
11
diff
changeset
|
45 //! * `enable_systemd` - on by default, the existence of this feature can allow your users to turn |
|
f740dadd2948
Added enable_systemd feature
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
11
diff
changeset
|
46 //! off systemd support if they don't need it. Note that it's already disabled on non-linux |
|
f740dadd2948
Added enable_systemd feature
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
11
diff
changeset
|
47 //! systems, so you don't need to care about that. |
| 0 | 48 //! * `serde` - implements `serde::Deserialize` for `SocketAddr` |
| 49 //! * `parse_arg` - implements `parse_arg::ParseArg` for `SocketAddr` | |
|
21
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
50 //! * `tokio` - adds `bind_tokio` method to `SocketAddr` (tokio 1.0) |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
51 //! * `tokio_0_2` - adds `bind_tokio_0_2` method to `SocketAddr` |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
52 //! * `tokio_0_3` - adds `bind_tokio_0_3` method to `SocketAddr` |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
53 //! * `async_std` - adds `bind_async_std` method to `SocketAddr` |
|
3
0edcde404b02
Added information about MSRV
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
2
diff
changeset
|
54 //! |
|
0edcde404b02
Added information about MSRV
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
2
diff
changeset
|
55 //! ## MSRV |
|
0edcde404b02
Added information about MSRV
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
2
diff
changeset
|
56 //! |
|
0edcde404b02
Added information about MSRV
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
2
diff
changeset
|
57 //! This crate must always compile with the latest Rust available in the latest Debian stable. |
|
0edcde404b02
Added information about MSRV
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
2
diff
changeset
|
58 //! That is currently Rust 1.41.1. (Debian 10 - Buster) |
|
0edcde404b02
Added information about MSRV
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
2
diff
changeset
|
59 |
|
22
f33e2c048104
Enable `doc_auto_cfg` in docs.rs builds
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
21
diff
changeset
|
60 #![cfg_attr(docsrs, feature(doc_auto_cfg))] |
| 0 | 61 |
| 62 #![deny(missing_docs)] | |
| 63 | |
| 64 pub mod error; | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
65 mod resolv_addr; |
| 0 | 66 |
| 67 use std::convert::{TryFrom, TryInto}; | |
| 68 use std::fmt; | |
| 69 use std::ffi::{OsStr, OsString}; | |
| 70 use crate::error::*; | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
71 use crate::resolv_addr::ResolvAddr; |
| 0 | 72 |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
73 #[cfg(not(all(target_os = "linux", feature = "enable_systemd")))] |
|
6
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
74 use std::convert::Infallible as Never; |
|
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
75 |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
76 #[cfg(all(target_os = "linux", feature = "enable_systemd"))] |
| 0 | 77 pub(crate) mod systemd_sockets { |
| 78 use std::fmt; | |
| 79 use std::sync::Mutex; | |
| 80 use libsystemd::activation::FileDescriptor; | |
|
20
2b78a483f84b
Update `libsystemd`
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
18
diff
changeset
|
81 use libsystemd::errors::SdError as LibSystemdError; |
|
2b78a483f84b
Update `libsystemd`
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
18
diff
changeset
|
82 type LibSystemdResult<T> = Result<T, LibSystemdError>; |
| 0 | 83 |
| 84 #[derive(Debug)] | |
| 85 pub(crate) struct Error(&'static Mutex<LibSystemdError>); | |
| 86 | |
| 87 impl fmt::Display for Error { | |
| 88 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
| 89 fmt::Display::fmt(&*self.0.lock().expect("mutex poisoned"), f) | |
| 90 } | |
| 91 } | |
| 92 | |
| 93 // No source we can't keep the mutex locked | |
| 94 impl std::error::Error for Error {} | |
| 95 | |
| 96 pub(crate) fn take(name: &str) -> Result<Option<FileDescriptor>, Error> { | |
| 97 match &*SYSTEMD_SOCKETS { | |
| 98 Ok(sockets) => Ok(sockets.take(name)), | |
| 99 Err(error) => Err(Error(error)) | |
| 100 } | |
| 101 } | |
| 102 | |
| 103 struct SystemdSockets(std::sync::Mutex<std::collections::HashMap<String, FileDescriptor>>); | |
| 104 | |
| 105 impl SystemdSockets { | |
| 106 fn new() -> LibSystemdResult<Self> { | |
| 107 // MUST BE true FOR SAFETY!!! | |
| 108 let map = libsystemd::activation::receive_descriptors_with_names(/*unset env = */ true)?.into_iter().map(|(fd, name)| (name, fd)).collect(); | |
| 109 Ok(SystemdSockets(Mutex::new(map))) | |
| 110 } | |
| 111 | |
| 112 fn take(&self, name: &str) -> Option<FileDescriptor> { | |
| 113 // MUST remove THE SOCKET FOR SAFETY!!! | |
| 114 self.0.lock().expect("poisoned mutex").remove(name) | |
| 115 } | |
| 116 } | |
| 117 | |
| 118 lazy_static::lazy_static! { | |
| 119 // We don't panic in order to let the application handle the error later | |
| 120 static ref SYSTEMD_SOCKETS: Result<SystemdSockets, Mutex<LibSystemdError>> = SystemdSockets::new().map_err(Mutex::new); | |
| 121 } | |
| 122 } | |
| 123 | |
| 124 /// Socket address that can be an ordinary address or a systemd socket | |
| 125 /// | |
| 126 /// This is the core type of this crate that abstracts possible addresses. | |
| 127 /// It can be (fallibly) converted from various types of strings or deserialized with `serde`. | |
| 128 /// After it's created, it can be bound as `TcpListener` from `std` or even `tokio` or `async_std` | |
| 129 /// if the appropriate feature is enabled. | |
| 130 /// | |
| 131 /// Optional dependencies on `parse_arg` and `serde` make it trivial to use with | |
| 132 /// [`configure_me`](https://crates.io/crates/configure_me). | |
| 133 #[derive(Debug)] | |
| 134 #[cfg_attr(feature = "serde", derive(serde_crate::Deserialize), serde(crate = "serde_crate", try_from = "serde_str_helpers::DeserBorrowStr"))] | |
| 135 pub struct SocketAddr(SocketAddrInner); | |
| 136 | |
| 137 impl SocketAddr { | |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
138 /// Creates SocketAddr from systemd name directly, without requiring `systemd://` prefix. |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
139 /// |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
140 /// Always fails with systemd unsupported error if systemd is not supported. |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
141 pub fn from_systemd_name<T: Into<String>>(name: T) -> Result<Self, ParseError> { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
142 Self::inner_from_systemd_name(name.into(), false) |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
143 } |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
144 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
145 #[cfg(all(target_os = "linux", feature = "enable_systemd"))] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
146 fn inner_from_systemd_name(name: String, prefixed: bool) -> Result<Self, ParseError> { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
147 let real_systemd_name = if prefixed { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
148 &name[SYSTEMD_PREFIX.len()..] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
149 } else { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
150 &name |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
151 }; |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
152 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
153 let name_len = real_systemd_name.len(); |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
154 match real_systemd_name.chars().enumerate().find(|(_, c)| !c.is_ascii() || *c < ' ' || *c == ':') { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
155 None if name_len <= 255 && prefixed => Ok(SocketAddr(SocketAddrInner::Systemd(name))), |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
156 None if name_len <= 255 && !prefixed => Ok(SocketAddr(SocketAddrInner::SystemdNoPrefix(name))), |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
157 None => Err(ParseErrorInner::LongSocketName { string: name, len: name_len }.into()), |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
158 Some((pos, c)) => Err(ParseErrorInner::InvalidCharacter { string: name, c, pos, }.into()), |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
159 } |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
160 } |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
161 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
162 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
163 #[cfg(not(all(target_os = "linux", feature = "enable_systemd")))] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
164 fn inner_from_systemd_name(name: String, _prefixed: bool) -> Result<Self, ParseError> { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
165 Err(ParseError(ParseErrorInner::SystemdUnsupported(name))) |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
166 } |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
167 |
| 0 | 168 /// Creates `std::net::TcpListener` |
| 169 /// | |
| 170 /// This method either `binds` the socket, if the address was provided or uses systemd socket | |
| 171 /// if the socket name was provided. | |
| 172 pub fn bind(self) -> Result<std::net::TcpListener, BindError> { | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
173 match self.0 { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
174 SocketAddrInner::Ordinary(addr) => match std::net::TcpListener::bind(addr) { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
175 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
176 Err(error) => Err(BindErrorInner::BindFailed { addr, error, }.into()), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
177 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
178 SocketAddrInner::WithHostname(addr) => match std::net::TcpListener::bind(addr.as_str()) { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
179 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
180 Err(error) => Err(BindErrorInner::BindOrResolvFailed { addr, error, }.into()), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
181 }, |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
182 SocketAddrInner::Systemd(socket_name) => Self::get_systemd(socket_name, true).map(|(socket, _)| socket), |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
183 SocketAddrInner::SystemdNoPrefix(socket_name) => Self::get_systemd(socket_name, false).map(|(socket, _)| socket), |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
184 } |
| 0 | 185 } |
| 186 | |
| 187 /// Creates `tokio::net::TcpListener` | |
| 188 /// | |
|
21
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
189 /// To be specific, it binds the socket or converts systemd socket to `tokio` 1.0 socket. |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
190 /// |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
191 /// This method either `binds` the socket, if the address was provided or uses systemd socket |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
192 /// if the socket name was provided. |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
193 #[cfg(feature = "tokio")] |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
194 pub async fn bind_tokio(self) -> Result<tokio::net::TcpListener, TokioBindError> { |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
195 match self.0 { |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
196 SocketAddrInner::Ordinary(addr) => match tokio::net::TcpListener::bind(addr).await { |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
197 Ok(socket) => Ok(socket), |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
198 Err(error) => Err(TokioBindError::Bind(BindErrorInner::BindFailed { addr, error, }.into())), |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
199 }, |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
200 SocketAddrInner::WithHostname(addr) => match tokio::net::TcpListener::bind(addr.as_str()).await { |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
201 Ok(socket) => Ok(socket), |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
202 Err(error) => Err(TokioBindError::Bind(BindErrorInner::BindOrResolvFailed { addr, error, }.into())), |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
203 }, |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
204 SocketAddrInner::Systemd(socket_name) => { |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
205 let (socket, addr) = Self::get_systemd(socket_name, true)?; |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
206 socket.try_into().map_err(|error| TokioConversionError { addr, error, }.into()) |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
207 }, |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
208 SocketAddrInner::SystemdNoPrefix(socket_name) => { |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
209 let (socket, addr) = Self::get_systemd(socket_name, false)?; |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
210 socket.try_into().map_err(|error| TokioConversionError { addr, error, }.into()) |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
211 }, |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
212 } |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
213 } |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
214 |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
215 /// Creates `tokio::net::TcpListener` |
|
f6334887e3c8
Support `tokio` 1.0
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
20
diff
changeset
|
216 /// |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
217 /// To be specific, it binds the socket or converts systemd socket to `tokio` 0.2 socket. |
| 0 | 218 /// |
| 219 /// This method either `binds` the socket, if the address was provided or uses systemd socket | |
| 220 /// if the socket name was provided. | |
| 221 #[cfg(feature = "tokio_0_2")] | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
222 pub async fn bind_tokio_0_2(self) -> Result<tokio_0_2::net::TcpListener, TokioBindError> { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
223 match self.0 { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
224 SocketAddrInner::Ordinary(addr) => match tokio_0_2::net::TcpListener::bind(addr).await { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
225 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
226 Err(error) => Err(TokioBindError::Bind(BindErrorInner::BindFailed { addr, error, }.into())), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
227 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
228 SocketAddrInner::WithHostname(addr) => match tokio_0_2::net::TcpListener::bind(addr.as_str()).await { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
229 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
230 Err(error) => Err(TokioBindError::Bind(BindErrorInner::BindOrResolvFailed { addr, error, }.into())), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
231 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
232 SocketAddrInner::Systemd(socket_name) => { |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
233 let (socket, addr) = Self::get_systemd(socket_name, true)?; |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
234 socket.try_into().map_err(|error| TokioConversionError { addr, error, }.into()) |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
235 }, |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
236 SocketAddrInner::SystemdNoPrefix(socket_name) => { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
237 let (socket, addr) = Self::get_systemd(socket_name, false)?; |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
238 socket.try_into().map_err(|error| TokioConversionError { addr, error, }.into()) |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
239 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
240 } |
| 0 | 241 } |
| 242 | |
| 243 /// Creates `tokio::net::TcpListener` | |
| 244 /// | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
245 /// To be specific, it binds the socket or converts systemd socket to `tokio` 0.3 socket. |
| 0 | 246 /// |
| 247 /// This method either `binds` the socket, if the address was provided or uses systemd socket | |
| 248 /// if the socket name was provided. | |
| 249 #[cfg(feature = "tokio_0_3")] | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
250 pub async fn bind_tokio_0_3(self) -> Result<tokio_0_3::net::TcpListener, TokioBindError> { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
251 match self.0 { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
252 SocketAddrInner::Ordinary(addr) => match tokio_0_3::net::TcpListener::bind(addr).await { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
253 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
254 Err(error) => Err(TokioBindError::Bind(BindErrorInner::BindFailed { addr, error, }.into())), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
255 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
256 SocketAddrInner::WithHostname(addr) => match tokio_0_3::net::TcpListener::bind(addr.as_str()).await { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
257 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
258 Err(error) => Err(TokioBindError::Bind(BindErrorInner::BindOrResolvFailed { addr, error, }.into())), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
259 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
260 SocketAddrInner::Systemd(socket_name) => { |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
261 let (socket, addr) = Self::get_systemd(socket_name, true)?; |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
262 socket.try_into().map_err(|error| TokioConversionError { addr, error, }.into()) |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
263 }, |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
264 SocketAddrInner::SystemdNoPrefix(socket_name) => { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
265 let (socket, addr) = Self::get_systemd(socket_name, false)?; |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
266 socket.try_into().map_err(|error| TokioConversionError { addr, error, }.into()) |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
267 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
268 } |
| 0 | 269 } |
| 270 | |
| 271 /// Creates `async_std::net::TcpListener` | |
| 272 /// | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
273 /// To be specific, it binds the socket or converts systemd socket to `async_std` socket. |
| 0 | 274 /// |
| 275 /// This method either `binds` the socket, if the address was provided or uses systemd socket | |
| 276 /// if the socket name was provided. | |
| 277 #[cfg(feature = "async-std")] | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
278 pub async fn bind_async_std(self) -> Result<async_std::net::TcpListener, BindError> { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
279 match self.0 { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
280 SocketAddrInner::Ordinary(addr) => match async_std::net::TcpListener::bind(addr).await { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
281 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
282 Err(error) => Err(BindErrorInner::BindFailed { addr, error, }.into()), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
283 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
284 SocketAddrInner::WithHostname(addr) => match async_std::net::TcpListener::bind(addr.as_str()).await { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
285 Ok(socket) => Ok(socket), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
286 Err(error) => Err(BindErrorInner::BindOrResolvFailed { addr, error, }.into()), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
287 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
288 SocketAddrInner::Systemd(socket_name) => { |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
289 let (socket, _) = Self::get_systemd(socket_name, true)?; |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
290 Ok(socket.into()) |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
291 }, |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
292 SocketAddrInner::SystemdNoPrefix(socket_name) => { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
293 let (socket, _) = Self::get_systemd(socket_name, false)?; |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
294 Ok(socket.into()) |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
295 }, |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
296 } |
| 0 | 297 } |
| 298 | |
| 299 // We can't impl<T: Deref<Target=str> + Into<String>> TryFrom<T> for SocketAddr because of orphan | |
| 300 // rules. | |
| 301 fn try_from_generic<'a, T>(string: T) -> Result<Self, ParseError> where T: 'a + std::ops::Deref<Target=str> + Into<String> { | |
| 302 if string.starts_with(SYSTEMD_PREFIX) { | |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
303 Self::inner_from_systemd_name(string.into(), true) |
| 0 | 304 } else { |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
305 match string.parse() { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
306 Ok(addr) => Ok(SocketAddr(SocketAddrInner::Ordinary(addr))), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
307 Err(_) => Ok(SocketAddr(SocketAddrInner::WithHostname(ResolvAddr::try_from_generic(string).map_err(ParseErrorInner::ResolvAddr)?))), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
308 } |
| 0 | 309 } |
| 310 } | |
| 311 | |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
312 #[cfg(all(target_os = "linux", feature = "enable_systemd"))] |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
313 fn get_systemd(socket_name: String, prefixed: bool) -> Result<(std::net::TcpListener, SocketAddrInner), BindError> { |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
314 use libsystemd::activation::IsType; |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
315 use std::os::unix::io::{FromRawFd, IntoRawFd}; |
| 0 | 316 |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
317 let real_systemd_name = if prefixed { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
318 &socket_name[SYSTEMD_PREFIX.len()..] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
319 } else { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
320 &socket_name |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
321 }; |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
322 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
323 let socket = systemd_sockets::take(real_systemd_name).map_err(BindErrorInner::ReceiveDescriptors)?; |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
324 // Safety: The environment variable is unset, so that no other calls can get the |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
325 // descriptors. The descriptors are taken from the map, not cloned, so they can't |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
326 // be duplicated. |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
327 unsafe { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
328 // match instead of combinators to avoid cloning socket_name |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
329 match socket { |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
330 Some(socket) if socket.is_inet() => Ok((std::net::TcpListener::from_raw_fd(socket.into_raw_fd()), SocketAddrInner::Systemd(socket_name))), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
331 Some(_) => Err(BindErrorInner::NotInetSocket(socket_name).into()), |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
332 None => Err(BindErrorInner::MissingDescriptor(socket_name).into()) |
|
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
333 } |
| 0 | 334 } |
| 335 } | |
|
6
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
336 |
|
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
337 // This approach makes the rest of the code much simpler as it doesn't require sprinkling it |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
338 // with #[cfg(all(target_os = "linux", feature = "enable_systemd"))] yet still statically guarantees it won't execute. |
|
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
339 #[cfg(not(all(target_os = "linux", feature = "enable_systemd")))] |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
340 fn get_systemd(socket_name: Never, _prefixed: bool) -> Result<(std::net::TcpListener, SocketAddrInner), BindError> { |
|
6
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
341 match socket_name {} |
|
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
342 } |
| 0 | 343 } |
| 344 | |
| 345 /// Displays the address in format that can be parsed again. | |
| 346 /// | |
| 347 /// **Important: While I don't expect this impl to change, don't rely on it!** | |
| 348 /// It should be used mostly for debugging/logging. | |
| 349 impl fmt::Display for SocketAddr { | |
| 350 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
| 351 fmt::Display::fmt(&self.0, f) | |
| 352 } | |
| 353 } | |
| 354 | |
| 355 impl fmt::Display for SocketAddrInner { | |
| 356 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
| 357 match self { | |
| 358 SocketAddrInner::Ordinary(addr) => fmt::Display::fmt(addr, f), | |
| 359 SocketAddrInner::Systemd(addr) => fmt::Display::fmt(addr, f), | |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
360 SocketAddrInner::SystemdNoPrefix(addr) => write!(f, "{}{}", SYSTEMD_PREFIX, addr), |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
361 SocketAddrInner::WithHostname(addr) => fmt::Display::fmt(addr, f), |
| 0 | 362 } |
| 363 } | |
| 364 } | |
| 365 | |
| 366 // PartialEq for testing, I'm not convinced it should be exposed | |
| 367 #[derive(Debug, PartialEq)] | |
| 368 enum SocketAddrInner { | |
| 369 Ordinary(std::net::SocketAddr), | |
|
4
66c0e10c89fc
Support resolving hostnames
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
3
diff
changeset
|
370 WithHostname(resolv_addr::ResolvAddr), |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
371 #[cfg(all(target_os = "linux", feature = "enable_systemd"))] |
| 0 | 372 Systemd(String), |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
373 #[cfg(not(all(target_os = "linux", feature = "enable_systemd")))] |
|
6
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
374 #[allow(dead_code)] |
|
a7893294e9b2
Make the crate compilable on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
4
diff
changeset
|
375 Systemd(Never), |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
376 #[cfg(all(target_os = "linux", feature = "enable_systemd"))] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
377 #[allow(dead_code)] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
378 SystemdNoPrefix(String), |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
379 #[cfg(not(all(target_os = "linux", feature = "enable_systemd")))] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
380 #[allow(dead_code)] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
381 SystemdNoPrefix(Never), |
| 0 | 382 } |
| 383 | |
| 384 const SYSTEMD_PREFIX: &str = "systemd://"; | |
| 385 | |
|
11
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
386 impl<I: Into<std::net::IpAddr>> From<(I, u16)> for SocketAddr { |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
387 fn from(value: (I, u16)) -> Self { |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
388 SocketAddr(SocketAddrInner::Ordinary(value.into())) |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
389 } |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
390 } |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
391 |
|
18
db1dc99252e2
Added From<std::net::SocketAddr>
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
17
diff
changeset
|
392 impl From<std::net::SocketAddr> for SocketAddr { |
|
db1dc99252e2
Added From<std::net::SocketAddr>
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
17
diff
changeset
|
393 fn from(value: std::net::SocketAddr) -> Self { |
|
db1dc99252e2
Added From<std::net::SocketAddr>
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
17
diff
changeset
|
394 SocketAddr(SocketAddrInner::Ordinary(value)) |
|
db1dc99252e2
Added From<std::net::SocketAddr>
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
17
diff
changeset
|
395 } |
|
db1dc99252e2
Added From<std::net::SocketAddr>
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
17
diff
changeset
|
396 } |
|
db1dc99252e2
Added From<std::net::SocketAddr>
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
17
diff
changeset
|
397 |
|
11
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
398 impl From<std::net::SocketAddrV4> for SocketAddr { |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
399 fn from(value: std::net::SocketAddrV4) -> Self { |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
400 SocketAddr(SocketAddrInner::Ordinary(value.into())) |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
401 } |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
402 } |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
403 |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
404 impl From<std::net::SocketAddrV6> for SocketAddr { |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
405 fn from(value: std::net::SocketAddrV6) -> Self { |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
406 SocketAddr(SocketAddrInner::Ordinary(value.into())) |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
407 } |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
408 } |
|
13e2a5545167
Implement From conversions
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
9
diff
changeset
|
409 |
| 0 | 410 impl std::str::FromStr for SocketAddr { |
| 411 type Err = ParseError; | |
| 412 | |
| 413 fn from_str(s: &str) -> Result<Self, Self::Err> { | |
| 414 SocketAddr::try_from_generic(s) | |
| 415 } | |
| 416 } | |
| 417 | |
| 418 impl<'a> TryFrom<&'a str> for SocketAddr { | |
| 419 type Error = ParseError; | |
| 420 | |
| 421 fn try_from(s: &'a str) -> Result<Self, Self::Error> { | |
| 422 SocketAddr::try_from_generic(s) | |
| 423 } | |
| 424 } | |
| 425 | |
| 426 impl TryFrom<String> for SocketAddr { | |
| 427 type Error = ParseError; | |
| 428 | |
| 429 fn try_from(s: String) -> Result<Self, Self::Error> { | |
| 430 SocketAddr::try_from_generic(s) | |
| 431 } | |
| 432 } | |
| 433 | |
| 434 impl<'a> TryFrom<&'a OsStr> for SocketAddr { | |
| 435 type Error = ParseOsStrError; | |
| 436 | |
| 437 fn try_from(s: &'a OsStr) -> Result<Self, Self::Error> { | |
| 438 s.to_str().ok_or(ParseOsStrError::InvalidUtf8)?.try_into().map_err(Into::into) | |
| 439 } | |
| 440 } | |
| 441 | |
| 442 impl TryFrom<OsString> for SocketAddr { | |
| 443 type Error = ParseOsStrError; | |
| 444 | |
| 445 fn try_from(s: OsString) -> Result<Self, Self::Error> { | |
| 446 s.into_string().map_err(|_| ParseOsStrError::InvalidUtf8)?.try_into().map_err(Into::into) | |
| 447 } | |
| 448 } | |
| 449 | |
| 450 #[cfg(feature = "serde")] | |
| 451 impl<'a> TryFrom<serde_str_helpers::DeserBorrowStr<'a>> for SocketAddr { | |
| 452 type Error = ParseError; | |
| 453 | |
| 454 fn try_from(s: serde_str_helpers::DeserBorrowStr<'a>) -> Result<Self, Self::Error> { | |
|
9
4fb70ca820a6
Upgrade serde_str_helpers
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
7
diff
changeset
|
455 SocketAddr::try_from_generic(s) |
| 0 | 456 } |
| 457 } | |
| 458 | |
| 459 #[cfg(feature = "parse_arg")] | |
| 460 impl parse_arg::ParseArg for SocketAddr { | |
| 461 type Error = ParseOsStrError; | |
| 462 | |
| 463 fn describe_type<W: fmt::Write>(mut writer: W) -> fmt::Result { | |
| 464 std::net::SocketAddr::describe_type(&mut writer)?; | |
| 465 write!(writer, " or a systemd socket name prefixed with systemd://") | |
| 466 } | |
| 467 | |
| 468 fn parse_arg(arg: &OsStr) -> Result<Self, Self::Error> { | |
| 469 arg.try_into() | |
| 470 } | |
| 471 | |
| 472 fn parse_owned_arg(arg: OsString) -> Result<Self, Self::Error> { | |
| 473 arg.try_into() | |
| 474 } | |
| 475 } | |
| 476 | |
| 477 #[cfg(test)] | |
| 478 mod tests { | |
| 479 use super::{SocketAddr, SocketAddrInner}; | |
| 480 | |
| 481 #[test] | |
| 482 fn parse_ordinary() { | |
| 483 assert_eq!("127.0.0.1:42".parse::<SocketAddr>().unwrap().0, SocketAddrInner::Ordinary(([127, 0, 0, 1], 42).into())); | |
| 484 } | |
| 485 | |
| 486 #[test] | |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
487 #[cfg(all(target_os = "linux", feature = "enable_systemd"))] |
| 0 | 488 fn parse_systemd() { |
| 489 assert_eq!("systemd://foo".parse::<SocketAddr>().unwrap().0, SocketAddrInner::Systemd("systemd://foo".to_owned())); | |
| 490 } | |
|
2
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
491 |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
492 #[test] |
|
16
bc76507dd878
Fixed conditional compilation based on OS
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
13
diff
changeset
|
493 #[cfg(not(all(target_os = "linux", feature = "enable_systemd")))] |
|
7
9731ff589d9c
Fix tests on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
6
diff
changeset
|
494 #[should_panic] |
|
9731ff589d9c
Fix tests on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
6
diff
changeset
|
495 fn parse_systemd() { |
|
9731ff589d9c
Fix tests on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
6
diff
changeset
|
496 "systemd://foo".parse::<SocketAddr>().unwrap(); |
|
9731ff589d9c
Fix tests on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
6
diff
changeset
|
497 } |
|
9731ff589d9c
Fix tests on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
6
diff
changeset
|
498 |
|
9731ff589d9c
Fix tests on non-linux systems
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
6
diff
changeset
|
499 #[test] |
|
2
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
500 #[should_panic] |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
501 fn parse_systemd_fail_control() { |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
502 "systemd://foo\n".parse::<SocketAddr>().unwrap(); |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
503 } |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
504 |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
505 #[test] |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
506 #[should_panic] |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
507 fn parse_systemd_fail_colon() { |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
508 "systemd://foo:".parse::<SocketAddr>().unwrap(); |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
509 } |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
510 |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
511 #[test] |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
512 #[should_panic] |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
513 fn parse_systemd_fail_non_ascii() { |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
514 "systemd://fooá".parse::<SocketAddr>().unwrap(); |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
515 } |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
516 |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
517 #[test] |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
518 #[should_panic] |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
519 fn parse_systemd_fail_too_long() { |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
520 "systemd://xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx".parse::<SocketAddr>().unwrap(); |
|
cabc4aafdd85
Added length check and a few tests
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
0
diff
changeset
|
521 } |
|
17
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
522 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
523 #[test] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
524 #[cfg_attr(not(all(target_os = "linux", feature = "enable_systemd")), should_panic)] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
525 fn no_prefix_parse_systemd() { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
526 SocketAddr::from_systemd_name("foo").unwrap(); |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
527 } |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
528 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
529 #[test] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
530 #[should_panic] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
531 fn no_prefix_parse_systemd_fail_non_ascii() { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
532 SocketAddr::from_systemd_name("fooá").unwrap(); |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
533 } |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
534 |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
535 #[test] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
536 #[should_panic] |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
537 fn no_prefix_parse_systemd_fail_too_long() { |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
538 SocketAddr::from_systemd_name("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx").unwrap(); |
|
dfb727367934
Allow specifying systemd name directly
Martin Habovstiak <martin.habovstiak@gmail.com>
parents:
16
diff
changeset
|
539 } |
| 0 | 540 } |
