Enum ListenAddress 

pub enum ListenAddress {
    Tcp(SocketAddr),
    Udp(SocketAddr),
    Unixgram(PathBuf),
    Unix(PathBuf),
}

A listen address.

Listen addresses are used to bind listeners to specific local addresses and ports, and multiple address families and protocols are supported. In textual form, listen addresses are represented as URLs, with the scheme indicating the protocol and the authority/path representing the address to listen on.

Examples

• tcp://127.0.0.1:6789 (listen on IPv4 loopback, TCP port 6789)
• udp://[::1]:53 (listen on IPv6 loopback, UDP port 53)
• unixgram:///tmp/app.socket (listen on a Unix datagram socket at /tmp/app.socket)
• unix:///tmp/app.socket (listen on a Unix stream socket at /tmp/app.socket)

Variants

Tcp(SocketAddr)

A TCP listen address.

Udp(SocketAddr)

A UDP listen address.

Unixgram(PathBuf)

A Unix datagram listen address.

Unix(PathBuf)

A Unix stream listen address.

Implementations

impl ListenAddress

pub const fn any_tcp(port: u16) -> Self

Creates a TCP address for the given port that listens on all interfaces.

pub const fn listener_type(&self) -> &'static str

Returns the socket type of the listen address.

pub fn as_local_connect_addr(&self) -> Option<SocketAddr>

Returns a socket address that can be used to connect to the configured listen address with a bias for local clients.

When the listen address is a TCP or UDP address, this method returns a socket address that can be used to connect to the listener bound to this listen addresss, such that if the listen address is unspecified (0.0.0.0), the client will connect locally using “localhost”. When the listen address is not “unspecified” or already uses “localhost”, this method returns the listen address as-is.

If the address is a Unix domain socket, this method returns None.

pub fn as_unix_stream_path(&self) -> Option<&Path>

Returns the Unix domain socket path if the address is a Unix domain socket in SOCK_STREAM mode.

Returns None otherwise.

Trait Implementations

impl Clone for ListenAddress

fn clone(&self) -> ListenAddress

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListenAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ListenAddress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ListenAddress

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

Formats the value using the given formatter.

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

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for ListenAddress

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.