crates/systemd-socket: src/lib.rs annotate

author	Martin Habovstiak <martin.habovstiak@gmail.com>
date	Thu, 26 Nov 2020 22:53:35 +0100
parents
children	cabc4aafdd85

rev	line source
0 a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	1 //! A convenience crate for optionally supporting systemd socket activation.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	2 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	3 //! ## About
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	4 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	5 //! The goal of this crate is to make socket activation with systemd in your project trivial.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	6 //! It provides a replacement for `std::net::SocketAddr` that allows parsing the bind address from string just like the one from `std`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	7 //! but on top of that also allows `systemd://socket_name` format that tells it to use systemd activation with given socket name.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	8 //! Then it provides a method to bind the address which will return the socket from systemd if available.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	9 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	10 //! The provided type supports conversions from various types of strings and also `serde` and `parse_arg` via feature flag.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	11 //! Thanks to this the change to your code should be minimal - parsing will continue to work, it'll just allow a new format.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	12 //! You only need to change the code to use `SocketAddr::bind()` instead of `TcpListener::bind()` for binding.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	13 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	14 //! Further, the crate also provides convenience methods for binding `tokio` 0.2, 0.3, and
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	15 //! `async_std` sockets if the appropriate features are activated.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	16 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	17 //! ## Example
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	18 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	19 //! ```no_run
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	20 //! use systemd_socket::SocketAddr;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	21 //! use std::convert::TryFrom;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	22 //! use std::io::Write;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	23 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	24 //! let mut args = std::env::args_os();
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	25 //! let program_name = args.next().expect("unknown program name");
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	26 //! let socket_addr = args.next().expect("missing socket address");
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	27 //! let socket_addr = SocketAddr::try_from(socket_addr).expect("failed to parse socket address");
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	28 //! let socket = socket_addr.bind().expect("failed to bind socket");
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	29 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	30 //! loop {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	31 //! let _ = socket
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	32 //! .accept()
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	33 //! .expect("failed to accept connection")
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	34 //! .0
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	35 //! .write_all(b"Hello world!")
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	36 //! .map_err(\|err\| eprintln!("Failed to send {}", err));
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	37 //! }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	38 //! ```
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	39 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	40 //! ## Features
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	41 //!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	42 //! * `serde` - implements `serde::Deserialize` for `SocketAddr`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	43 //! * `parse_arg` - implements `parse_arg::ParseArg` for `SocketAddr`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	44 //! * `tokio_0_2` - adds `bind_tokio_0_2` convenience method to `SocketAddr`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	45 //! * `tokio_0_3` - adds `bind_tokio_0_3` convenience method to `SocketAddr`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	46 //! * `async_std` - adds `bind_async_std` convenience method to `SocketAddr`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	47
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	48 #![deny(missing_docs)]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	49
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	50 pub mod error;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	51
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	52 use std::convert::{TryFrom, TryInto};
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	53 use std::fmt;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	54 use std::ffi::{OsStr, OsString};
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	55 use crate::error::*;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	56
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	57 pub(crate) mod systemd_sockets {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	58 use std::fmt;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	59 use std::sync::Mutex;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	60 use libsystemd::activation::FileDescriptor;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	61 use libsystemd::errors::Error as LibSystemdError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	62 use libsystemd::errors::Result as LibSystemdResult;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	63
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	64 #[derive(Debug)]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	65 pub(crate) struct Error(&'static Mutex<LibSystemdError>);
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	66
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	67 impl fmt::Display for Error {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	68 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	69 fmt::Display::fmt(&*self.0.lock().expect("mutex poisoned"), f)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	70 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	71 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	72
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	73 // No source we can't keep the mutex locked
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	74 impl std::error::Error for Error {}
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	75
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	76 pub(crate) fn take(name: &str) -> Result<Option<FileDescriptor>, Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	77 match &*SYSTEMD_SOCKETS {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	78 Ok(sockets) => Ok(sockets.take(name)),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	79 Err(error) => Err(Error(error))
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	80 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	81 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	82
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	83 struct SystemdSockets(std::sync::Mutex<std::collections::HashMap<String, FileDescriptor>>);
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	84
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	85 impl SystemdSockets {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	86 fn new() -> LibSystemdResult<Self> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	87 // MUST BE true FOR SAFETY!!!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	88 let map = libsystemd::activation::receive_descriptors_with_names(/unset env = / true)?.into_iter().map(\|(fd, name)\| (name, fd)).collect();
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	89 Ok(SystemdSockets(Mutex::new(map)))
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	90 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	91
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	92 fn take(&self, name: &str) -> Option<FileDescriptor> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	93 // MUST remove THE SOCKET FOR SAFETY!!!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	94 self.0.lock().expect("poisoned mutex").remove(name)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	95 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	96 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	97
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	98 lazy_static::lazy_static! {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	99 // We don't panic in order to let the application handle the error later
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	100 static ref SYSTEMD_SOCKETS: Result<SystemdSockets, Mutex<LibSystemdError>> = SystemdSockets::new().map_err(Mutex::new);
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	101 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	102 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	103
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	104 /// Socket address that can be an ordinary address or a systemd socket
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	105 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	106 /// This is the core type of this crate that abstracts possible addresses.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	107 /// It can be (fallibly) converted from various types of strings or deserialized with `serde`.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	108 /// After it's created, it can be bound as `TcpListener` from `std` or even `tokio` or `async_std`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	109 /// if the appropriate feature is enabled.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	110 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	111 /// Optional dependencies on `parse_arg` and `serde` make it trivial to use with
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	112 /// [`configure_me`](https://crates.io/crates/configure_me).
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	113 #[derive(Debug)]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	114 #[cfg_attr(feature = "serde", derive(serde_crate::Deserialize), serde(crate = "serde_crate", try_from = "serde_str_helpers::DeserBorrowStr"))]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	115 pub struct SocketAddr(SocketAddrInner);
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	116
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	117 impl SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	118 /// Creates `std::net::TcpListener`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	119 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	120 /// This method either `binds` the socket, if the address was provided or uses systemd socket
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	121 /// if the socket name was provided.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	122 pub fn bind(self) -> Result<std::net::TcpListener, BindError> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	123 self._bind().map(\|(socket, _)\| socket)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	124 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	125
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	126 /// Creates `tokio::net::TcpListener`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	127 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	128 /// To be specific, it binds the socket and converts it to `tokio` 0.2 socket.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	129 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	130 /// This method either `binds` the socket, if the address was provided or uses systemd socket
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	131 /// if the socket name was provided.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	132 #[cfg(feature = "tokio_0_2")]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	133 pub fn bind_tokio_0_2(self) -> Result<tokio_0_2::net::TcpListener, TokioBindError> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	134 let (socket, addr) = self._bind()?;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	135 socket.try_into().map_err(\|error\| TokioConversionError { addr, error, }.into())
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	136 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	137
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	138 /// Creates `tokio::net::TcpListener`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	139 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	140 /// To be specific, it binds the socket and converts it to `tokio` 0.3 socket.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	141 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	142 /// This method either `binds` the socket, if the address was provided or uses systemd socket
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	143 /// if the socket name was provided.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	144 #[cfg(feature = "tokio_0_3")]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	145 pub fn bind_tokio_0_3(self) -> Result<tokio_0_3::net::TcpListener, TokioBindError> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	146 let (socket, addr) = self._bind()?;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	147 socket.try_into().map_err(\|error\| TokioConversionError { addr, error, }.into())
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	148 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	149
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	150 /// Creates `async_std::net::TcpListener`
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	151 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	152 /// To be specific, it binds the socket and converts it to `async_std` socket.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	153 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	154 /// This method either `binds` the socket, if the address was provided or uses systemd socket
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	155 /// if the socket name was provided.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	156 #[cfg(feature = "async-std")]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	157 pub fn bind_async_std(self) -> Result<async_std::net::TcpListener, BindError> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	158 let (socket, _) = self._bind()?;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	159 Ok(socket.into())
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	160 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	161
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	162 // We can't impl<T: Deref<Target=str> + Into<String>> TryFrom<T> for SocketAddr because of orphan
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	163 // rules.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	164 fn try_from_generic<'a, T>(string: T) -> Result<Self, ParseError> where T: 'a + std::ops::Deref<Target=str> + Into<String> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	165 if string.starts_with(SYSTEMD_PREFIX) {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	166 match string[SYSTEMD_PREFIX.len()..].chars().enumerate().find(\|(_, c)\| !c.is_ascii() \|\| c < ' ' \|\| c == ':') {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	167 None => Ok(SocketAddr(SocketAddrInner::Systemd(string.into()))),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	168 Some((pos, c)) => Err(ParseErrorInner::InvalidCharacter { string: string.into(), c, pos, }.into()),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	169 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	170 } else {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	171 Ok(string.parse().map(SocketAddrInner::Ordinary).map(SocketAddr).map_err(ParseErrorInner::SocketAddr)?)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	172 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	173 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	174
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	175 fn _bind(self) -> Result<(std::net::TcpListener, SocketAddrInner), BindError> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	176 match self.0 {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	177 SocketAddrInner::Ordinary(addr) => match std::net::TcpListener::bind(addr) {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	178 Ok(socket) => Ok((socket, SocketAddrInner::Ordinary(addr))),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	179 Err(error) => Err(BindErrorInner::BindFailed { addr, error, }.into()),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	180 },
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	181 SocketAddrInner::Systemd(socket_name) => {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	182 use libsystemd::activation::IsType;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	183 use std::os::unix::io::{FromRawFd, IntoRawFd};
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	184
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	185 let socket = systemd_sockets::take(&socket_name[SYSTEMD_PREFIX.len()..]).map_err(BindErrorInner::ReceiveDescriptors)?;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	186 // Safety: The environment variable is unset, so that no other calls can get the
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	187 // descriptors. The descriptors are taken from the map, not cloned, so they can't
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	188 // be duplicated.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	189 unsafe {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	190 // match instead of combinators to avoid cloning socket_name
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	191 match socket {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	192 Some(socket) if socket.is_inet() => Ok((std::net::TcpListener::from_raw_fd(socket.into_raw_fd()), SocketAddrInner::Systemd(socket_name))),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	193 Some(_) => Err(BindErrorInner::NotInetSocket(socket_name).into()),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	194 None => Err(BindErrorInner::MissingDescriptor(socket_name).into())
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	195 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	196 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	197 },
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	198 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	199 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	200 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	201
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	202 /// Displays the address in format that can be parsed again.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	203 ///
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	204 /// Important: While I don't expect this impl to change, don't rely on it!
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	205 /// It should be used mostly for debugging/logging.
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	206 impl fmt::Display for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	207 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	208 fmt::Display::fmt(&self.0, f)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	209 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	210 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	211
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	212 impl fmt::Display for SocketAddrInner {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	213 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	214 match self {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	215 SocketAddrInner::Ordinary(addr) => fmt::Display::fmt(addr, f),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	216 SocketAddrInner::Systemd(addr) => fmt::Display::fmt(addr, f),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	217 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	218 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	219 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	220
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	221 // PartialEq for testing, I'm not convinced it should be exposed
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	222 #[derive(Debug, PartialEq)]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	223 enum SocketAddrInner {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	224 Ordinary(std::net::SocketAddr),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	225 Systemd(String),
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	226 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	227
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	228 const SYSTEMD_PREFIX: &str = "systemd://";
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	229
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	230 impl std::str::FromStr for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	231 type Err = ParseError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	232
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	233 fn from_str(s: &str) -> Result<Self, Self::Err> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	234 SocketAddr::try_from_generic(s)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	235 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	236 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	237
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	238 impl<'a> TryFrom<&'a str> for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	239 type Error = ParseError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	240
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	241 fn try_from(s: &'a str) -> Result<Self, Self::Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	242 SocketAddr::try_from_generic(s)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	243 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	244 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	245
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	246 impl TryFrom<String> for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	247 type Error = ParseError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	248
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	249 fn try_from(s: String) -> Result<Self, Self::Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	250 SocketAddr::try_from_generic(s)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	251 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	252 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	253
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	254 impl<'a> TryFrom<&'a OsStr> for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	255 type Error = ParseOsStrError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	256
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	257 fn try_from(s: &'a OsStr) -> Result<Self, Self::Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	258 s.to_str().ok_or(ParseOsStrError::InvalidUtf8)?.try_into().map_err(Into::into)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	259 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	260 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	261
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	262 impl TryFrom<OsString> for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	263 type Error = ParseOsStrError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	264
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	265 fn try_from(s: OsString) -> Result<Self, Self::Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	266 s.into_string().map_err(\|_\| ParseOsStrError::InvalidUtf8)?.try_into().map_err(Into::into)
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	267 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	268 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	269
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	270 #[cfg(feature = "serde")]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	271 impl<'a> TryFrom<serde_str_helpers::DeserBorrowStr<'a>> for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	272 type Error = ParseError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	273
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	274 fn try_from(s: serde_str_helpers::DeserBorrowStr<'a>) -> Result<Self, Self::Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	275 SocketAddr::try_from_generic(std::borrow::Cow::from(s))
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	276 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	277 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	278
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	279 #[cfg(feature = "parse_arg")]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	280 impl parse_arg::ParseArg for SocketAddr {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	281 type Error = ParseOsStrError;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	282
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	283 fn describe_type<W: fmt::Write>(mut writer: W) -> fmt::Result {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	284 std::net::SocketAddr::describe_type(&mut writer)?;
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	285 write!(writer, " or a systemd socket name prefixed with systemd://")
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	286 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	287
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	288 fn parse_arg(arg: &OsStr) -> Result<Self, Self::Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	289 arg.try_into()
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	290 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	291
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	292 fn parse_owned_arg(arg: OsString) -> Result<Self, Self::Error> {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	293 arg.try_into()
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	294 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	295 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	296
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	297 #[cfg(test)]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	298 mod tests {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	299 use super::{SocketAddr, SocketAddrInner};
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	300
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	301 #[test]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	302 fn parse_ordinary() {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	303 assert_eq!("127.0.0.1:42".parse::<SocketAddr>().unwrap().0, SocketAddrInner::Ordinary(([127, 0, 0, 1], 42).into()));
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	304 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	305
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	306 #[test]
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	307 fn parse_systemd() {
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	308 assert_eq!("systemd://foo".parse::<SocketAddr>().unwrap().0, SocketAddrInner::Systemd("systemd://foo".to_owned()));
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	309 }
a65053246c29 Initial commit Martin Habovstiak <martin.habovstiak@gmail.com> parents: diff changeset	310 }

0

a65053246c29 Initial commit