Struct Listen

pub(crate) struct Listen(Vec<ListenItem>);

Specification of (possibly) something to listen on (eg, a port, or some addresses/ports)

Can represent, at least:

• “do not listen”
• Listen on the following port on localhost (IPv6 and IPv4)
• Listen on precisely the following address and port
• Listen on several addresses/ports

Currently only IP (v6 and v4) is supported.

Tuple Fields

0: Vec<ListenItem>

Implementations

impl Listen

pub fn new_none() -> Listen

Create a new Listen specifying no addresses (no listening)

pub fn new_localhost(port: u16) -> Listen

Create a new Listen specifying listening on a port on localhost

Special case: if port is zero, specifies no listening.

pub fn new_localhost_optional(port: Option<u16>) -> Listen

Create a new Listen, possibly specifying listening on a port on localhost

Special case: if port is Some(0), also specifies no listening.

pub fn is_empty(&self) -> bool

Return true if no listening addresses have been configured

pub fn ip_addrs( &self, ) -> Result<impl Iterator<Item = impl Iterator<Item = SocketAddr>>, ListenUnsupported>

List the network socket addresses to listen on

Each returned item is a list of SocketAddr, of which at least one must be successfully bound. It is OK if the others (up to all but one of them) fail with EAFNOSUPPORT (“Address family not supported”). This allows handling of support, or non-support, for particular address families, eg IPv6 vs IPv4 localhost. Other errors (eg, EADDRINUSE) should always be treated as serious problems.

Fails if the listen spec involves listening on things other than IP addresses. (Currently that is not possible.)

pub fn localhost_port_legacy(&self) -> Result<Option<u16>, ListenUnsupported>

Get the localhost port to listen on

Returns None if listening is configured to be disabled.

Fails, giving an unsupported error, if the configuration isn’t just “listen on a single localhost port in all address families”

pub fn single_address_legacy( &self, ) -> Result<Option<SocketAddr>, ListenUnsupported>

Get a single address to listen on

Returns None if listening is configured to be disabled.

If the configuration is “listen on a single port”, treats this as a request to listening on IPv4 only. Use of this function implies a bug: lack of proper support for the current internet protocol IPv6. It should only be used if an underlying library or facility is likewise buggy.

Fails, giving an unsupported error, if the configuration isn’t just “listen on a single port on one address family”.

pub fn is_localhost_only(&self) -> bool

Return true if this Listen only configures listening on localhost.

Trait Implementations

impl Clone for Listen

fn clone(&self) -> Listen

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Listen

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

Formats the value using the given formatter.

impl Default for Listen

fn default() -> Listen

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Listen

fn deserialize<__D>( __deserializer: __D, ) -> Result<Listen, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Listen

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

Formats the value using the given formatter.

impl Hash for Listen

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

where __H: Hasher,

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 Listen

fn cmp(&self, other: &Listen) -> 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 Listen

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

fn partial_cmp(&self, other: &Listen) -> 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 Serialize for Listen

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ListenSerde> for Listen

type Error = InvalidListen

The type returned in the event of a conversion error.

fn try_from( l: ListenSerde, ) -> Result<Listen, <Listen as TryFrom<ListenSerde>>::Error>

Performs the conversion.

impl Eq for Listen

impl StructuralPartialEq for Listen