Enum ListenItem 

enum ListenItem {
    Port(u16),
    Auto,
    AutoPort(IpAddr),
    General(SocketAddr),
}

One item in the CustomizableListen.

This type defines a common format for parsing. We don’t assign any particular meaning to the variants. For example a standalone port doesn’t imply anything about what IP address should be used. Similarly, a port of 0 doesn’t have any inherent meaning. For example a port of 0 might mean “don’t listen” (when network addresses are optional) or might mean “raise an error” (when network addresses are required). It’s up to the user of this type to assign meaning to the values given.

We distinguish a standalone port, rather than just storing two net:SocketAddr, so that we can handle localhost (which means two address families) specially in order to implement localhost_port_legacy().

Variants

Port(u16)

One port, both IPv6 and IPv4

Auto

IPv6 and/or IPv4, arbitrarily chosen ports.

AutoPort(IpAddr)

Specific address, arbitrarily chosen port.

General(SocketAddr)

Any other single socket address

Implementations

impl ListenItem

fn iter<'a>( &'a self, ips_for_port: impl IntoIterator<Item = IpAddr> + 'a, ) -> impl Iterator<Item = SocketAddr> + 'a

Return the SocketAddrs implied by this item

If the item is a standalone port, then the returned iterator will return a socket address using that port for each IP address in ips_for_port.

fn is_auto(&self) -> bool

Return true if this ListenItem is “addr:auto” or “auto”

fn is_port_zero(&self) -> bool

Return true if this ListenItem is using an explicit (deprecated) port value of 0.

Trait Implementations

impl Clone for ListenItem

fn clone(&self) -> ListenItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListenItem

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

Formats the value using the given formatter.

impl Display for ListenItem

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

Formats the value using the given formatter.

impl From<ListenItem> for ListenItemSerde

fn from(i: ListenItem) -> Self

Converts to this type from the input type.

impl Hash for ListenItem

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 ListenItem

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

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

fn partial_cmp(&self, other: &ListenItem) -> 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 TryFrom<ListenItemSerde> for ListenItem

type Error = InvalidCustomizableListen

The type returned in the event of a conversion error.

fn try_from(i: ListenItemSerde) -> Result<ListenItem, Self::Error>

Performs the conversion.

impl Eq for ListenItem

impl StructuralPartialEq for ListenItem