Enum EndpointAddr

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

Variants

Direct

Fields

addr: SocketAddr

Agent

Fields

agent: SocketAddr

outer: SocketAddr

Implementations

impl EndpointAddr

pub fn direct(addr: SocketAddr) -> EndpointAddr

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

pub fn addr(&self) -> SocketAddr

Returns the outer address of this EndpointAddr

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

pub fn encoding_size(&self) -> usize

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 EndpointAddr

fn clone(&self) -> EndpointAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointAddr

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

Formats the value using the given formatter.

impl Deref for EndpointAddr

type Target = SocketAddr

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for EndpointAddr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EndpointAddr

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

Formats the value using the given formatter.

impl FromStr for EndpointAddr

type Err = AddrParseError

The associated error which can be returned from parsing.

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

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

impl Hash for EndpointAddr

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

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

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

fn to_endpoint_addr(self) -> EndpointAddr

impl Copy for EndpointAddr

impl Eq for EndpointAddr

impl StructuralPartialEq for EndpointAddr