Enum ListenerAddress

#[non_exhaustive]
pub enum ListenerAddress {
    Tcp(SocketAddr),
    Path(PathBuf),
    Abstract(String),
    Inetd,
    FromFd(i32),
    FromFdNamed(String),
}

Abstraction over socket address that instructs in which way and at what address (if any) [Listener] should listen for incoming stream connections.

All address variants are available on all platforms, regardness of actual support in the Listener or enabled crate features.

If serde is enabled, it is serialized/deserialized the same as string, same as as in the CLI, using FromStr/Display.

See variants documentation for FromStr string patterns that are accepted by ListenerAddress parser

If you are not using clap helper types then remember to copy or link those documentation snippets into your app’s documentation.

let addr : ListenerAddress = "127.0.0.1:8087".parse().unwrap();
let addr : ListenerAddress = "[::]:80".parse().unwrap();
let addr : ListenerAddress = "/path/to/socket".parse().unwrap();
let addr : ListenerAddress = "@abstract_linux_address".parse().unwrap();
let addr : ListenerAddress = "inetd".parse().unwrap();
let addr : ListenerAddress = "sd-listen".parse().unwrap();
let addr : ListenerAddress = "SD_LISTEN".parse().unwrap();
let addr : ListenerAddress = "sd-listen:named_socket".parse().unwrap();
let addr : ListenerAddress = "sd-listen:*".parse().unwrap();

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Tcp(SocketAddr)

Usual server TCP socket. Triggered by specifying IPv4 or IPv6 address and port pair. Example: 127.0.0.1:8080.

Hostnames are not supported.

Path(PathBuf)

Path-based UNIX socket. Path must begin with / or ..
Examples: /tmp/mysock, ./mysock

Abstract(String)

Linux abstract-namespaced UNIX socket. Indicated by using @ as a first character. Example: @server

Inetd

“inetd” or “Accept=yes” mode where stdin and stdout (file descriptors 0 and 1) are used together as a socket and only one connection is served. Triggered by using inetd or stdio or - as the address.

FromFd(i32)

SystemD’s “Accept=no” mode - using manually specified file descriptor as a pre-created server socket ready to accept TCP or UNIX connections. Triggered by specifying sd-listen as address, which sets 3 as file descriptor number.

FromFdNamed(String)

SystemD’s “Accept=no” mode - relying on LISTEN_FDNAMES environment variable instead of using the hard coded number Triggered by using appending a colon and a name after sd-listen. Example: sd-listen:mynamedsock

Special name * means to bind all passed addresses simultaneously, if multi-listener crate feature is enabled.

Trait Implementations

impl Clone for ListenerAddress

fn clone(&self) -> ListenerAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListenerAddress

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

Formats the value using the given formatter.

impl Display for ListenerAddress

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

Formats the value using the given formatter.

impl FromStr for ListenerAddress

type Err = &'static str

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 Hash for ListenerAddress

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ListenerAddress

fn cmp(&self, other: &ListenerAddress) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ListenerAddress

fn eq(&self, other: &ListenerAddress) -> 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 PartialOrd for ListenerAddress

fn partial_cmp(&self, other: &ListenerAddress) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ListenerAddress

impl StructuralPartialEq for ListenerAddress