Struct systemd_socket::SocketAddr

pub struct SocketAddr(/* private fields */);

Socket address that can be an ordinary address or a systemd socket

This is the core type of this crate that abstracts possible addresses. It can be (fallibly) converted from various types of strings or deserialized with serde. After it’s created, it can be bound as TcpListener from std or even tokio or async_std if the appropriate feature is enabled.

Optional dependencies on parse_arg and serde make it trivial to use with configure_me.

Implementations

impl SocketAddr

pub fn from_systemd_name<T: Into<String>>(name: T) -> Result<Self, ParseError>

Creates SocketAddr from systemd name directly, without requiring systemd:// prefix.

Always fails with systemd unsupported error if systemd is not supported.

pub fn bind(self) -> Result<TcpListener, BindError>

Creates std::net::TcpListener

This method either binds the socket, if the address was provided or uses systemd socket if the socket name was provided.

pub async fn bind_tokio(self) -> Result<TcpListener, TokioBindError>

Available on crate feature tokio only.

Creates tokio::net::TcpListener

To be specific, it binds the socket or converts systemd socket to tokio 1.0 socket.

This method either binds the socket, if the address was provided or uses systemd socket if the socket name was provided.

pub async fn bind_tokio_0_2(self) -> Result<TcpListener, TokioBindError>

Available on crate feature tokio_0_2 only.

Creates tokio::net::TcpListener

To be specific, it binds the socket or converts systemd socket to tokio 0.2 socket.

This method either binds the socket, if the address was provided or uses systemd socket if the socket name was provided.

pub async fn bind_tokio_0_3(self) -> Result<TcpListener, TokioBindError>

Available on crate feature tokio_0_3 only.

Creates tokio::net::TcpListener

To be specific, it binds the socket or converts systemd socket to tokio 0.3 socket.

This method either binds the socket, if the address was provided or uses systemd socket if the socket name was provided.

pub async fn bind_async_std(self) -> Result<TcpListener, BindError>

Available on crate feature async-std only.

Creates async_std::net::TcpListener

To be specific, it binds the socket or converts systemd socket to async_std socket.

This method either binds the socket, if the address was provided or uses systemd socket if the socket name was provided.

Trait Implementations

impl Debug for SocketAddr

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SocketAddr

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SocketAddr

Displays the address in format that can be parsed again.

Important: While I don’t expect this impl to change, don’t rely on it! It should be used mostly for debugging/logging.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I: Into<IpAddr>> From<(I, u16)> for SocketAddr

fn from(value: (I, u16)) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for SocketAddr

fn from(value: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddrV4> for SocketAddr

fn from(value: SocketAddrV4) -> Self

Converts to this type from the input type.

impl From<SocketAddrV6> for SocketAddr

fn from(value: SocketAddrV6) -> Self

Converts to this type from the input type.

impl FromStr for SocketAddr

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl ParseArg for SocketAddr

Available on crate feature parse_arg only.

type Error = ParseOsStrError

Type returned in Err variant of Result when parsing fails.

fn describe_type<W: Write>(writer: W) -> Result

Writes human-readable description of the type to the writer.

fn parse_arg(arg: &OsStr) -> Result<Self, Self::Error>

Parses the argument.

fn parse_owned_arg(arg: OsString) -> Result<Self, Self::Error>

Parses the argument consuming it.

impl<'a> TryFrom<&'a OsStr> for SocketAddr

type Error = ParseOsStrError

The type returned in the event of a conversion error.

fn try_from(s: &'a OsStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for SocketAddr

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<DeserBorrowStr<'a>> for SocketAddr

Available on crate feature serde only.

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: DeserBorrowStr<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OsString> for SocketAddr

type Error = ParseOsStrError

The type returned in the event of a conversion error.

fn try_from(s: OsString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for SocketAddr

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.