Struct libp2p_core::Multiaddr

pub struct Multiaddr { /* fields omitted */ }

Representation of a Multiaddr.

Methods

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 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 parity_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 parity_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 [push] but more efficient if this Multiaddr has no living clones.

pub fn iter(&self) -> Iter

Returns the components of this multiaddress.

use std::net::Ipv4Addr;
use parity_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.

Trait Implementations

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, 

Feeds a slice of this type into the given [Hasher].

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Bytes) -> 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 TryFrom<BytesMut> for Multiaddr

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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<'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 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 Eq for Multiaddr

impl Debug for Multiaddr

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

Formats the value using the given formatter.

impl Display for Multiaddr

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

Convert a Multiaddr to a string

Examples

use parity_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 PartialEq<Multiaddr> 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: &Multiaddr) -> bool

This method tests for !=.

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

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

Performs the conversion.

impl From<IpAddr> for Multiaddr

fn from(v: IpAddr) -> Multiaddr

Performs the conversion.

impl From<Ipv4Addr> for Multiaddr

fn from(v: Ipv4Addr) -> Multiaddr

Performs the conversion.

impl From<Ipv6Addr> for Multiaddr

fn from(v: Ipv6Addr) -> Multiaddr

Performs the conversion.

impl AsRef<[u8]> for Multiaddr

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

Performs the conversion.

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 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.