Struct MultiAddr 

pub struct MultiAddr { /* private fields */ }

Composable, self-describing network address with an optional PeerId suffix.

Wraps a TransportAddr (which describes how to reach a network endpoint) with an optional peer identity (which describes who is behind it).

Implementations

impl MultiAddr

pub fn new(transport: TransportAddr) -> Self

Create a MultiAddr from a TransportAddr.

pub fn quic(addr: SocketAddr) -> Self

Shorthand for TransportAddr::Quic.

pub fn tcp(addr: SocketAddr) -> Self

Shorthand for TransportAddr::Tcp.

pub fn with_peer_id(self, peer_id: PeerId) -> Self

Builder: attach a PeerId to this address.

pub fn from_ip_port(ip: IpAddr, port: u16) -> Self

Create a QUIC MultiAddr from an IP address and port.

pub fn from_ipv4(ip: Ipv4Addr, port: u16) -> Self

Create a QUIC MultiAddr from an IPv4 address and port.

pub fn from_ipv6(ip: Ipv6Addr, port: u16) -> Self

Create a QUIC MultiAddr from an IPv6 address and port.

pub fn transport(&self) -> &TransportAddr

The underlying transport address.

pub fn peer_id(&self) -> Option<&PeerId>

Optional peer identity suffix.

pub fn is_quic(&self) -> bool

true when this address uses the QUIC transport — the only transport currently supported for dialing. When additional transports are added, update this method (and Self::dialable_socket_addr) accordingly.

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

Returns the SocketAddr only for transports we can currently dial (QUIC). Returns None for all other transports, including IP-based ones like TCP that we do not yet support.

Use Self::socket_addr when you need the raw socket address regardless of transport (e.g. IP diversity checks, geo lookups).

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

Returns the socket address for IP-based transports (Quic, Tcp, Udp), None for non-IP transports.

pub fn ip(&self) -> Option<IpAddr>

Returns the IP address for IP-based transports, None otherwise.

pub fn port(&self) -> Option<u16>

Returns the port for IP-based transports, None otherwise.

pub fn is_ipv4(&self) -> bool

true for IP-based transports with IPv4 addressing.

pub fn is_ipv6(&self) -> bool

true for IP-based transports with IPv6 addressing.

pub fn is_loopback(&self) -> bool

true if this is an IP-based loopback address, false otherwise.

pub fn is_private(&self) -> bool

true if this is an IP-based private/link-local address, false otherwise.

Trait Implementations

impl Clone for MultiAddr

fn clone(&self) -> MultiAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiAddr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultiAddr

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for MultiAddr

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

Formats the value using the given formatter.

impl From<TransportAddr> for MultiAddr

fn from(transport: TransportAddr) -> Self

Converts to this type from the input type.

impl FromStr for MultiAddr

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for MultiAddr

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 MultiAddr

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

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for MultiAddr

impl StructuralPartialEq for MultiAddr