Struct PeerTarget 

pub struct PeerTarget {
    pub peer_id: PeerId,
    pub network_id: String,
    /* private fields */
}

A description of the peer to connect to.

The caller supplies the peer’s stable PeerId (for mTLS verification) and any candidate addresses it knows (from discovery / the address manager / the relay peer list). At least one direct candidate OR peer_id+relay reachability is needed; the strategy uses the candidate list for the direct/mapping methods and peer_id for the relay-coordinated + relayed methods.

Address-family policy — IPv6-first, IPv4-fallback

The candidate list is stored IPv6-first: every IPv6 candidate precedes every IPv4 candidate, with the relative order WITHIN each family preserved (a stable sort). This is the foundation of the ecosystem’s IPv6-first / IPv4-fallback rule — the dialer walks the candidates in order (happy-eyeballs, crate::dialer) so a peer reachable over IPv6 is dialed over IPv6, and IPv4 is used only when the IPv6 candidate(s) fail. Ordering is decided by the address FAMILY (SocketAddr::is_ipv6), never by a string heuristic. Use PeerTarget::with_addrs to supply several candidates (they are sorted for you); PeerTarget::with_addr for a single one.

Fields

peer_id: PeerId

The peer’s network identity — SHA-256 of its TLS SPKI DER. Used to VERIFY the mTLS peer and to address it over the relay. Required.

network_id: String

The network id the peer registered under (relay network_id, e.g. DIG_MAINNET). Used to scope relay peer lookups + hole-punch coordination.

Implementations

impl PeerTarget

pub fn with_addr( peer_id: PeerId, direct_addr: SocketAddr, network_id: impl Into<String>, ) -> Self

A peer known by a single direct address (public / port-forwarded / discovered).

pub fn with_addrs( peer_id: PeerId, direct_addrs: Vec<SocketAddr>, network_id: impl Into<String>, ) -> Self

A peer known by one OR MORE direct candidate addresses. The candidates are stored IPv6-first (IPv6 candidates before IPv4, order-preserving within each family) so the dialer prefers IPv6 and falls back to IPv4 — pass them in any order.

pub fn relay_only(peer_id: PeerId, network_id: impl Into<String>) -> Self

A peer known only by identity — reachable via relay-coordinated methods.

pub fn direct_addrs(&self) -> &[SocketAddr]

The peer’s candidate addresses, ordered IPv6-first (the dial order). Empty for a relay-only target.

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

The single best (IPv6-preferred) candidate address, or None for a relay-only target.

This is the backwards-compatible accessor for callers that want ONE address: it returns the first candidate, which — because the list is IPv6-first — is the IPv6 candidate when one is known, otherwise the IPv4 fallback. Prefer PeerTarget::direct_addrs to honour the full happy-eyeballs fallback.

pub fn set_direct_addrs(&mut self, addrs: Vec<SocketAddr>)

Replace the candidate list, re-establishing the IPv6-first ordering.

Trait Implementations

impl Clone for PeerTarget

fn clone(&self) -> PeerTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeerTarget

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

Formats the value using the given formatter.

impl Eq for PeerTarget

impl PartialEq for PeerTarget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PeerTarget