Enum NatResolver 

pub enum NatResolver {
    Any,
    Upnp,
    PublicIp,
    ExternalIp(IpAddr),
    ExternalAddr(String),
    NetIf,
    None,
}

All builtin resolvers.

Variants

Any

Resolve with any available resolver.

Upnp

Resolve external IP via UPnP.

PublicIp

Resolve external IP via a network request.

ExternalIp(IpAddr)

Use the given IpAddr

ExternalAddr(String)

Use the given domain name as the external address to expose to peers. This is behaving essentially the same as NatResolver::ExternalIp, but supports domain names. Domain names are resolved to IP addresses using the OS’s resolver. The first IP address found is used. This may be useful in docker bridge networks where containers are usually queried by DNS instead of direct IP addresses. Note: the domain shouldn’t include a port number. Only the IP address is resolved.

NetIf

Resolve external IP via the network interface.

None

Resolve nothing

Implementations

impl NatResolver

pub async fn external_addr(self) -> Option<IpAddr>

Attempts to produce an IP address (best effort).

Panics

Network and interface resolution require an active Tokio runtime. Only Self::ExternalIp and Self::None are guaranteed to work without one.

pub fn as_external_ip(self, port: u16) -> Option<IpAddr>

Returns the fixed ip, if it is NatResolver::ExternalIp or NatResolver::ExternalAddr.

In the case of NatResolver::ExternalAddr, it will return the first IP address found for the domain. This performs blocking DNS resolution; async callers should use Self::external_addr instead.

Trait Implementations

impl Clone for NatResolver

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NatResolver

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

Formats the value using the given formatter.

impl Default for NatResolver

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NatResolver

where Self: FromStr, <Self as FromStr>::Err: Display,

Available on crate feature serde only.

fn deserialize<__D>(deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NatResolver

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

Formats the value using the given formatter.

impl Eq for NatResolver

impl FromStr for NatResolver

type Err = ParseNatResolverError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for NatResolver

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

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NatResolver

where Self: Display,

Available on crate feature serde only.

fn serialize<__S>(&self, serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NatResolver

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes

Size for each variant:

• Any: 0 bytes
• Upnp: 0 bytes
• PublicIp: 0 bytes
• ExternalIp: 17 bytes
• ExternalAddr: 31 bytes
• NetIf: 0 bytes
• None: 0 bytes