Struct Multiaddr

pub struct Multiaddr(/* private fields */);

Implementations

impl Multiaddr

pub fn empty() -> Self

pub fn iter(&self) -> Iter<'_>

pub fn pop<'a>(&mut self) -> Option<Protocol<'a>>

pub fn push(&mut self, p: Protocol<'_>)

pub fn replace<'a, F>(&self, at: usize, by: F) -> Option<Multiaddr>

where F: FnOnce(&Protocol<'_>) -> Option<Protocol<'a>>,

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn to_anemo_address(&self) -> Result<Address, &'static str>

Attempts to convert a multiaddr of the form /[ip4,ip6,dns]/{}/udp/{port} into an anemo address

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

pub fn to_socket_addr(&self) -> Result<SocketAddr>

pub fn is_loosely_valid_tcp_addr(&self) -> bool

pub fn with_zero_ip(&self) -> Self

Set the ip address to 0.0.0.0. For instance, it converts the following address /ip4/155.138.174.208/tcp/1500/http into /ip4/0.0.0.0/tcp/1500/http. This is useful when starting a server and you want to listen on all interfaces.

pub fn with_localhost_ip(&self) -> Self

Set the ip address to 127.0.0.1. For instance, it converts the following address /ip4/155.138.174.208/tcp/1500/http into /ip4/127.0.0.1/tcp/1500/http.

pub fn is_localhost_ip(&self) -> bool

pub fn hostname(&self) -> Option<String>

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

pub fn rewrite_udp_to_tcp(&self) -> Self

pub fn is_private_or_unroutable(&self, allow_private_addresses: bool) -> bool

Checks if the multiaddr contains a private/unroutable IP address or invalid DNS. Returns true if the address should is private or unroutable.

pub fn is_valid_public_anemo_address( &self, allow_private_addresses: bool, ) -> bool

Checks if the multiaddr is suitable for public announcement for anemo. This includes checking for private/unroutable addresses and valid format.

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: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

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 FromStr for Multiaddr

type Err = Error

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 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 Ord for Multiaddr

fn cmp(&self, other: &Multiaddr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for Multiaddr

fn partial_cmp(&self, other: &Multiaddr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Multiaddr

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSocketAddrs for Multiaddr

type Iter = Box<dyn Iterator<Item = SocketAddr>>

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved SocketAddrs.

impl<'a> TryFrom<&'a str> for Multiaddr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Multiaddr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Multiaddr

impl StructuralPartialEq for Multiaddr