Enum SocketEndpointAddr

pub enum SocketEndpointAddr {
    Direct {
        addr: SocketAddr,
    },
    Agent {
        agent: SocketAddr,
        outer: SocketAddr,
    },
}

Variants

Direct

Fields

addr: SocketAddr

Agent

Fields

agent: SocketAddr

outer: SocketAddr

Implementations

impl SocketEndpointAddr

pub fn direct(addr: SocketAddr) -> SocketEndpointAddr

pub fn with_agent(agent: SocketAddr, outer: SocketAddr) -> SocketEndpointAddr

pub fn addr(&self) -> SocketAddr

Returns the outer addr of this SocketEndpointAddr

Note: Before successful hole punching with this Endpoint, packets should be sent to the addr returned by deref() to establish communication. Once hole punching is successful or about to begin, use the addr returned by this function.

Methods from Deref<Target = SocketAddr>

pub fn ip(&self) -> IpAddr

Returns the IP address associated with this socket address.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));

pub fn port(&self) -> u16

Returns the port number associated with this socket address.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.port(), 8080);

pub fn is_ipv4(&self) -> bool

Returns true if the IP address in this SocketAddr is an IPv4 address, and false otherwise.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.is_ipv4(), true);
assert_eq!(socket.is_ipv6(), false);

pub fn is_ipv6(&self) -> bool

Returns true if the IP address in this SocketAddr is an IPv6 address, and false otherwise.

Examples

use std::net::{IpAddr, Ipv6Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 0, 1)), 8080);
assert_eq!(socket.is_ipv4(), false);
assert_eq!(socket.is_ipv6(), true);

Trait Implementations

impl Clone for SocketEndpointAddr

fn clone(&self) -> SocketEndpointAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketEndpointAddr

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

Formats the value using the given formatter.

impl Deref for SocketEndpointAddr

type Target = SocketAddr

The resulting type after dereferencing.

fn deref(&self) -> &<SocketEndpointAddr as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for SocketEndpointAddr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SocketEndpointAddr

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

Formats the value using the given formatter.

impl From<(SocketAddr, SocketAddr)> for SocketEndpointAddr

fn from(_: (SocketAddr, SocketAddr)) -> SocketEndpointAddr

Converts to this type from the input type.

impl From<SocketAddr> for SocketEndpointAddr

fn from(addr: SocketAddr) -> SocketEndpointAddr

Converts to this type from the input type.

impl From<SocketEndpointAddr> for EndpointAddr

fn from(value: SocketEndpointAddr) -> EndpointAddr

Converts to this type from the input type.

impl FromStr for SocketEndpointAddr

type Err = AddrParseError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<SocketEndpointAddr, <SocketEndpointAddr as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for SocketEndpointAddr

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 SocketEndpointAddr

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

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

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

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<EndpointAddr> for SocketEndpointAddr

type Error = TryIntoError<EndpointAddr>

The type returned in the event of a conversion error.

fn try_from( value: EndpointAddr, ) -> Result<SocketEndpointAddr, TryIntoError<EndpointAddr>>

Performs the conversion.

impl Copy for SocketEndpointAddr

impl Eq for SocketEndpointAddr

impl StructuralPartialEq for SocketEndpointAddr