Struct sc_network::types::Multiaddr

pub struct Multiaddr { /* private fields */ }

Representation of a Multiaddr.

Implementations

impl Multiaddr

pub fn empty() -> Multiaddr

Create a new, empty multiaddress.

pub fn with_capacity(n: usize) -> Multiaddr

Create a new, empty multiaddress with the given capacity.

pub fn len(&self) -> usize

Return the length in bytes of this multiaddress.

pub fn is_empty(&self) -> bool

Returns true if the length of this multiaddress is 0.

pub fn to_vec(&self) -> Vec<u8>

Return a copy of this Multiaddr’s byte representation.

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

Adds an already-parsed address component to the end of this multiaddr.

Examples

use multiaddr::{Multiaddr, Protocol};

let mut address: Multiaddr = "/ip4/127.0.0.1".parse().unwrap();
address.push(Protocol::Tcp(10000));
assert_eq!(address, "/ip4/127.0.0.1/tcp/10000".parse().unwrap());

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

Pops the last Protocol of this multiaddr, or None if the multiaddr is empty.

use multiaddr::{Multiaddr, Protocol};

let mut address: Multiaddr = "/ip4/127.0.0.1/udt/sctp/5678".parse().unwrap();

assert_eq!(address.pop().unwrap(), Protocol::Sctp(5678));
assert_eq!(address.pop().unwrap(), Protocol::Udt);

pub fn with(self, p: Protocol<'_>) -> Multiaddr

Like Multiaddr::push but consumes self.

pub fn with_p2p(self, peer: PeerId) -> Result<Multiaddr, Multiaddr>

Appends the given PeerId if not yet present at the end of this multiaddress.

Fails if this address ends in a different PeerId. In that case, the original, unmodified address is returned.

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

Returns the components of this multiaddress.

Example

use std::net::Ipv4Addr;
use multiaddr::{Multiaddr, Protocol};

let address: Multiaddr = "/ip4/127.0.0.1/udt/sctp/5678".parse().unwrap();

let components = address.iter().collect::<Vec<_>>();
assert_eq!(components[0], Protocol::Ip4(Ipv4Addr::new(127, 0, 0, 1)));
assert_eq!(components[1], Protocol::Udt);
assert_eq!(components[2], Protocol::Sctp(5678));

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

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

Replace a Protocol at some position in this Multiaddr.

The parameter at denotes the index of the protocol at which the function by will be applied to the current protocol, returning an optional replacement.

If at is out of bounds or by does not yield a replacement value, None will be returned. Otherwise a copy of this Multiaddr with the updated Protocol at position at will be returned.

pub fn ends_with(&self, other: &Multiaddr) -> bool

Checks whether the given Multiaddr is a suffix of this Multiaddr.

pub fn protocol_stack(&self) -> ProtoStackIter<'_>

Returns &str identifiers for the protocol names themselves. This omits specific info like addresses, ports, peer IDs, and the like. Example: "/ip4/127.0.0.1/tcp/5001" would return ["ip4", "tcp"]

Trait Implementations

impl AsRef<[u8]> for Multiaddr

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Multiaddr

fn clone(&self) -> Multiaddr

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Multiaddr

fn deserialize<D>( deserializer: D, ) -> Result<Multiaddr, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Multiaddr

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

Convert a Multiaddr to a string

Example

use multiaddr::Multiaddr;

let address: Multiaddr = "/ip4/127.0.0.1/udt".parse().unwrap();
assert_eq!(address.to_string(), "/ip4/127.0.0.1/udt");

impl From<IpAddr> for Multiaddr

fn from(v: IpAddr) -> Multiaddr

Converts to this type from the input type.

impl From<Ipv4Addr> for Multiaddr

fn from(v: Ipv4Addr) -> Multiaddr

Converts to this type from the input type.

impl From<Ipv6Addr> for Multiaddr

fn from(v: Ipv6Addr) -> Multiaddr

Converts to this type from the input type.

impl From<Multiaddr> for Multiaddr

fn from(multiaddr: Multiaddr) -> Multiaddr

Converts to this type from the input type.

impl From<Multiaddr> for Multiaddr

fn from(multiaddr: Multiaddr) -> Multiaddr

Converts to this type from the input type.

impl<'a> From<Protocol<'a>> for Multiaddr

fn from(p: Protocol<'a>) -> Multiaddr

Converts to this type from the input type.

impl<'a> FromIterator<Protocol<'a>> for Multiaddr

fn from_iter<T>(iter: T) -> Multiaddr

where T: IntoIterator<Item = Protocol<'a>>,

Creates a value from an iterator.

impl FromStr for Multiaddr

type Err = Error

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Multiaddr, Error>

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

impl Hash for Multiaddr

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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<'a> IntoIterator for &'a Multiaddr

type Item = Protocol<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a>

Creates an iterator from a value.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Multiaddr

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Multiaddr, 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(s: String) -> Result<Multiaddr, Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Multiaddr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Vec<u8>) -> Result<Multiaddr, Error>

Performs the conversion.

impl Eq for Multiaddr

impl StructuralPartialEq for Multiaddr