Struct IpListenEndpoint 

pub struct IpListenEndpoint {
    pub addr: Option<Address>,
    pub port: u16,
}

An internet endpoint address for listening.

In contrast with Endpoint, ListenEndpoint allows leaving the address unspecified, in order to listen on a given port at more than one of our addresses. The address field has three states, which are exactly the three ways a bind can be scoped:

• None: any address, of either IP version, a dual-stack bind.
• Some(addr) with an unspecified address (0.0.0.0 / ::): any address of that version, and none of the other one.
• Some(addr) with a concrete address: that address alone.

An endpoint can be constructed from a port alone, in which case the address is None, and from an (address, port) pair, in which case it is Some. So (Ipv4Address::UNSPECIFIED, 80) is the “any IPv4 address” bind, and (Ipv6Address::UNSPECIFIED, 80) the IPv6 one.

Fields

addr: Option<Address>

port: u16

Implementations

impl ListenEndpoint

pub const UNSPECIFIED: ListenEndpoint

The fully wildcard endpoint: any address of any version, port zero.

pub fn concrete_addr(&self) -> Option<Address>

The address, if it is a concrete one, neither absent nor unspecified. That is, one of our addresses rather than a filter over several.

pub fn version(&self) -> Option<Version>

The IP version this endpoint is restricted to, if it is restricted to one.

pub fn is_specified(&self) -> bool

Query whether the endpoint names one concrete address and a nonzero port.

Trait Implementations

impl Clone for ListenEndpoint

fn clone(&self) -> ListenEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ListenEndpoint

impl Debug for ListenEndpoint

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

Formats the value using the given formatter.

impl Default for ListenEndpoint

fn default() -> ListenEndpoint

Returns the “default value” for a type.

impl Display for ListenEndpoint

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

Formats the value using the given formatter.

impl Eq for ListenEndpoint

impl Format for ListenEndpoint

where Option<Address>: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<T> From<(T, u16)> for ListenEndpoint

where T: Into<Address>,

fn from(_: (T, u16)) -> ListenEndpoint

Converts to this type from the input type.

impl From<Endpoint> for ListenEndpoint

fn from(endpoint: Endpoint) -> ListenEndpoint

Converts to this type from the input type.

impl From<SocketAddr> for ListenEndpoint

Available on crate features ipv4 and ipv6 only.

fn from(x: SocketAddr) -> ListenEndpoint

Converts to this type from the input type.

impl From<u16> for ListenEndpoint

fn from(port: u16) -> ListenEndpoint

Converts to this type from the input type.

impl Hash for ListenEndpoint

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 ListenEndpoint

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ListenEndpoint

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