Struct ListenAddress

pub struct ListenAddress {
    pub protocol: Protocol,
    pub address: Option<IpAddr>,
    pub port: Option<u16>,
}

A listener’s address, with the protocol, ip address, and port.

String representation

A ListenAddress can be represented as a string in the format protocol:ip-address:port.

The protocol is the string representation of a links-supported Protocol (see its documentation for more info). The protocol is case-insensitive and can not be omitted.

The ip address is an IPv4 address literal (e.g. 0.0.0.0, 127.0.0.1, or 198.51.100.35), an IPv6 address literal in square brackets (e.g. [::], [::1], or [2001:db8:6ca1:573d:15c7:075f:5de5:cd30]), or can be omitted. The listener will listen for incoming connections on the specified address. Address 0.0.0.0 can be used to listen on all IPv4 (but not IPv6) addresses, address [::] can be used to listen on all IPv6 (but not IPv4) addresses. An empty (omitted) address can be used to listen on all addresses, IPv4 and IPv6, though this requires OS support for dual stack sockets (which is common but not universal). In the case of lack of such support, an empty address is equivalent to [::], and as such will listen on all IPv6 (but not IPv4) addresses.

The port is a TCP/UDP port (currently only TCP is used, but UDP may be used in the future for some protocols). An empty (omitted) port means the default port for the specified protocol (see Protocol). Port 0 can be used to request and ephemeral port from the operating system, however this is not recommended for server applications such as links.

Fields

protocol: Protocol

The protocol that the listener will process. See Protocol for details.

address: Option<IpAddr>

The address of the listener. An unspecified (omitted) address will listen on all addresses (OS support is not universal, see ListenAddress).

port: Option<u16>

The port (TCP and UDP) that the listener will use. An unspecified port means the default port of the protocol.

Trait Implementations

impl Clone for ListenAddress

fn clone(&self) -> ListenAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListenAddress

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

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, fmt: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl From<ListenAddress> for String

fn from(address: ListenAddress) -> Self

Converts to this type from the input type.

impl FromStr for ListenAddress

type Err = IntoListenAddressError

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 PartialEq for ListenAddress

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ListenAddress

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ListenAddress

type Error = IntoListenAddressError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for ListenAddress

impl Eq for ListenAddress