Enum NatError 

pub enum NatError {
    AllMethodsFailed(Vec<MethodError>),
    NoMethodsEnabled,
    PeerIdentityMismatch {
        expected: String,
        actual: String,
    },
    InvalidConfig(String),
}

The single error type returned by the public crate::connect API.

A connection attempt degrades gracefully: each method is tried with bounded timeouts and, if all enabled methods fail, NatError::AllMethodsFailed is returned with the ordered list of per-method failures. connect never panics and never hangs — a stuck method is bounded by its timeout and surfaces here as a [MethodError::Timeout].

Variants

AllMethodsFailed(Vec<MethodError>)

Every enabled traversal method failed. Carries the ordered per-method reasons (the order is the attempt order: direct → UPnP → NAT-PMP → PCP → hole-punch → relayed).

NoMethodsEnabled

No traversal methods were enabled in the config, so there was nothing to try.

PeerIdentityMismatch

The mTLS session was established but the peer’s identity did not match the expected peer_id (SHA-256 of its TLS SubjectPublicKeyInfo DER). This is a hard security failure: the transport connected but to the wrong (or an unverifiable) peer.

Fields

expected: String

The peer_id the caller asked to connect to (hex).

actual: String

The peer_id derived from the certificate the remote actually presented (hex).

InvalidConfig(String)

Configuration was invalid (e.g. an unparseable relay endpoint or a bad local identity).

Implementations

impl NatError

pub fn rpc_error_code(&self) -> i32

The peer-RPC error code a node should surface when this connect failure bubbles up to its RPC layer. A failed traversal (all methods failed / peer identity mismatch / nothing enabled) is rpc_error_codes::PEER_UNREACHABLE (-32006) per the L7 spec.

Trait Implementations

impl Debug for NatError

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

Formats the value using the given formatter.

impl Display for NatError

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

Formats the value using the given formatter.

impl Error for NatError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.