Struct ockam_multiaddr::MultiAddr

pub struct MultiAddr { /* private fields */ }

A sequence of Protocols.

Implementations

impl MultiAddr

pub fn new(r: Registry) -> Self

Create an empty address with an explicit protocol codec registry.

pub fn registry(&self) -> &Registry

Access the registry of this MultiAddr.

pub fn try_from_str(input: &str, r: Registry) -> Result<Self, Error>

Try to parse the given string as a multi-address.

Alternative to the corresponding TryFrom impl, accepting an explicit protocol codec registry.

pub fn try_from_bytes(input: &[u8], r: Registry) -> Result<Self, Error>

Try to decode the given bytes as a multi-address.

Alternative to the corresponding TryFrom impl, accepting an explicit protocol codec registry.

pub fn is_empty(&self) -> bool

Does this multi-address contain any protocol components?

pub fn len(&self) -> usize

Address length in bytes.

pub fn push_back<'a, P: Protocol<'a>>(&mut self, p: P) -> Result<(), Error>

Add a protocol to the end of this address.

pub fn push_back_value(&mut self, p: &ProtoValue<'_>) -> Result<(), Error>

Add a protocol value to the end of this address.

pub fn push_front<'a, P: Protocol<'a>>(&mut self, p: P) -> Result<(), Error>

Add a protocol to the front of this address.

pub fn push_front_value(&mut self, p: &ProtoValue<'_>) -> Result<(), Error>

Add a protocol value to the front of this address.

pub fn pop_back<'b>(&mut self) -> Option<ProtoValue<'b>>

Remove and return the last protocol component.

O(n) in the number of protocols.

pub fn pop_front(&mut self) -> Option<ProtoValue<'_>>

Remove and return the first protocol component.

pub fn drop_first(&mut self)

Remove the first protocol component.

pub fn drop_last(&mut self)

Remove the last protocol component.

O(n) in the number of protocols.

pub fn first(&self) -> Option<ProtoValue<'_>>

Return a reference to the first protocol component.

pub fn last(&self) -> Option<ProtoValue<'_>>

Return a reference to the last protocol component.

O(n) in the number of protocols.

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

Get an iterator over the protocol components.

pub fn shrink_to_fit(&mut self)

Drop any excess capacity.

pub fn try_extend<'a, T>(&mut self, iter: T) -> Result<(), Error>where T: IntoIterator<Item = ProtoValue<'a>>,

Try to extend this multi-address with another sequence of protocols.

pub fn try_with<'a, T>(self, iter: T) -> Result<Self, Error>where T: IntoIterator<Item = ProtoValue<'a>>,

Like try_extend but moves Self.

pub fn matches<'a, I>(&self, start: usize, codes: I) -> boolwhere I: IntoIterator<Item = &'a Match>, I::IntoIter: ExactSizeIterator,

Check if the protocol codes match the given sequence.

pub fn split(&self, at: usize) -> (MultiAddr, MultiAddr)

pub fn concat_mut(&mut self, other: &MultiAddr) -> Result<(), Error>

pub fn concat(self, other: &MultiAddr) -> Result<MultiAddr, Error>

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) -> Self

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

Formats the value using the given formatter.

impl Default for MultiAddr

fn default() -> Self

Returns the “default value” for a type.

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

type Item = ProtoValue<'a>

The type of the elements being iterated over.

type IntoIter = ProtoIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<MultiAddr> for MultiAddr

fn eq(&self, other: &Self) -> 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 TryFrom<&[u8]> for MultiAddr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for MultiAddr

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for MultiAddr