Enum SocketAddress 

pub enum SocketAddress {
    IpV4(SocketAddressV4),
    IpV6(SocketAddressV6),
}

An IP socket address, either IPv4 or IPv6, with a specific port.

Instead of using std::net::SocketAddr, this implementation is geared towards no_std environments and zerocopy decoding.

The size is also consistent across target operating systems.

Variants

IpV4(SocketAddressV4)

IpV6(SocketAddressV6)

Implementations

impl SocketAddress

pub fn ip(&self) -> IpAddress

pub fn port(&self) -> u16

pub fn set_port(&mut self, port: u16)

pub const fn unicast_scope(&self) -> Option<UnicastScope>

pub fn to_ipv6_mapped(self) -> SocketAddressV6

Converts the IP address into a IPv6 mapped address

pub fn unmap(self) -> Self

Converts the IP address into IPv4 if it is mapped, otherwise the address is unchanged

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

Returns true if the two addresses are equal from a network perspective.

This will unmap IPv4-mapped addresses to IpV4 tagged enum values

Trait Implementations

impl Clone for SocketAddress

fn clone(&self) -> SocketAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketAddress

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

Formats the value using the given formatter.

impl Default for SocketAddress

fn default() -> Self

Returns the “default value” for a type.

impl Display for SocketAddress

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

Formats the value using the given formatter.

impl From<(IpAddr, u16)> for SocketAddress

fn from((ip, port): (IpAddr, u16)) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for SocketAddress

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddress> for LocalAddress

fn from(value: SocketAddress) -> Self

Converts to this type from the input type.

impl From<SocketAddress> for RemoteAddress

fn from(value: SocketAddress) -> Self

Converts to this type from the input type.

impl From<SocketAddress> for SocketAddr

fn from(address: SocketAddress) -> Self

Converts to this type from the input type.

impl From<SocketAddressV4> for SocketAddress

fn from(addr: SocketAddressV4) -> Self

Converts to this type from the input type.

impl From<SocketAddressV6> for SocketAddress

fn from(addr: SocketAddressV6) -> Self

Converts to this type from the input type.

impl Hash for SocketAddress

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<'a> IntoEvent<SocketAddress<'a>> for &'a SocketAddress

fn into_event(self) -> SocketAddress<'a>

impl<'a> IntoEvent<SocketAddress<'a>> for &'a SocketAddress

fn into_event(self) -> SocketAddress<'a>

impl Ord for SocketAddress

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

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

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

type Iter = Once<SocketAddr>

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved SocketAddrs.

impl Unspecified for SocketAddress

fn is_unspecified(&self) -> bool

Returns true if the value is unspecified

fn filter_unspecified(self) -> Option<Self>

Coerce a potentially unspecified value into an Option<Self>

impl Copy for SocketAddress

impl Eq for SocketAddress

impl StructuralPartialEq for SocketAddress