Struct multiaddr::Multiaddr

source ·
pub struct Multiaddr { /* private fields */ }
Expand description

Representation of a Multiaddr.

Implementations§

source§

impl Multiaddr

source

pub fn empty() -> Self

Create a new, empty multiaddress.

source

pub fn with_capacity(n: usize) -> Self

Create a new, empty multiaddress with the given capacity.

source

pub fn len(&self) -> usize

Return the length in bytes of this multiaddress.

source

pub fn is_empty(&self) -> bool

Returns true if the length of this multiaddress is 0.

source

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

Return a copy of this Multiaddr’s byte representation.

source

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());
source

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);
source

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

Like Multiaddr::push but consumes self.

source

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

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.

source

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));
source

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.

source

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

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

source

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§

source§

impl AsRef<[u8]> for Multiaddr

source§

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

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

impl Clone for Multiaddr

source§

fn clone(&self) -> Multiaddr

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Multiaddr

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn deserialize<D>(deserializer: D) -> StdResult<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Multiaddr

source§

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

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");
source§

impl From<IpAddr> for Multiaddr

source§

fn from(v: IpAddr) -> Multiaddr

Converts to this type from the input type.
source§

impl From<Ipv4Addr> for Multiaddr

source§

fn from(v: Ipv4Addr) -> Multiaddr

Converts to this type from the input type.
source§

impl From<Ipv6Addr> for Multiaddr

source§

fn from(v: Ipv6Addr) -> Multiaddr

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = Protocol<'a>>,

Creates a value from an iterator. Read more
source§

impl FromStr for Multiaddr

§

type Err = Error

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl Hash for Multiaddr

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

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?
source§

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

Creates an iterator from a value. Read more
source§

impl Ord for Multiaddr

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Multiaddr

source§

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

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

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

impl PartialOrd for Multiaddr

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Serialize for Multiaddr

source§

fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

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

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(s: &'a str) -> Result<Multiaddr>

Performs the conversion.
source§

impl TryFrom<String> for Multiaddr

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(s: String) -> Result<Multiaddr>

Performs the conversion.
source§

impl TryFrom<Vec<u8>> for Multiaddr

§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(v: Vec<u8>) -> Result<Self>

Performs the conversion.
source§

impl Eq for Multiaddr

source§

impl StructuralEq for Multiaddr

source§

impl StructuralPartialEq for Multiaddr

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,