Struct MethodOutcome 

pub struct MethodOutcome {
    pub kind: TraversalKind,
    pub dial_addrs: Vec<SocketAddr>,
}

What a traversal method yields on success: the dialable candidate addresses for the peer (in discovery order), plus which technique produced them. The crate::strategy then performs the mTLS dial, dig-ip selecting the family-aware order — IPv6-first over the local∩peer family intersection with IPv4 fallback (see crate::dialer) — except the relayed method, which returns the already-open relay tunnel.

The direct/mapping methods carry the peer’s whole candidate list so the dial can fall back across families; the hole-punch/relayed methods yield a single coordinated/relay address (MethodOutcome::single).

Fields

kind: TraversalKind

Which technique produced these reachable addresses.

dial_addrs: Vec<SocketAddr>

The candidate addresses the strategy should dial, in discovery order (peer public endpoints, a hole-punched peer address, the relay endpoint, or — mapping methods — the peer candidates to try after opening the local pinhole). dig-ip orders them IPv6-first over the local∩peer intersection at dial time. Never empty on success.

Implementations

impl MethodOutcome

pub fn single(kind: TraversalKind, dial_addr: SocketAddr) -> Self

An outcome carrying a SINGLE dial address (hole-punch / relayed tiers, which yield one coordinated peer address or the relay endpoint).

pub fn candidates(kind: TraversalKind, dial_addrs: Vec<SocketAddr>) -> Self

An outcome carrying the peer’s candidate list (direct / mapping tiers), in discovery order. The IPv6-first preference + local∩peer family intersection are applied at dial time by dig-ip (crate::dialer), so the addresses are stored as the method produced them.

pub fn dial_addr(&self) -> Option<SocketAddr>

The first dial address in discovery order, or None if empty.

Trait Implementations

impl Clone for MethodOutcome

fn clone(&self) -> MethodOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MethodOutcome

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

Formats the value using the given formatter.

impl Eq for MethodOutcome

impl PartialEq for MethodOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MethodOutcome