Enum multiaddr::Protocol

pub enum Protocol<'a> {
    Dccp(u16),
    Dns(Cow<'a, str>),
    Dns4(Cow<'a, str>),
    Dns6(Cow<'a, str>),
    Dnsaddr(Cow<'a, str>),
    Http,
    Https,
    Ip4(Ipv4Addr),
    Ip6(Ipv6Addr),
    P2pWebRtcDirect,
    P2pWebRtcStar,
    P2pWebSocketStar,
    Memory(u64),
    Onion(Cow<'a, [u8; 10]>, u16),
    Onion3(Onion3Addr<'a>),
    P2p(Multihash),
    P2pCircuit,
    Quic,
    Sctp(u16),
    Tcp(u16),
    Udp(u16),
    Udt,
    Unix(Cow<'a, str>),
    Utp,
    Ws(Cow<'a, str>),
    Wss(Cow<'a, str>),
}

Protocol describes all possible multiaddress protocols.

For Unix, Ws and Wss we use &str instead of Path to allow cross-platform usage of Protocol since encoding Paths to bytes is platform-specific. This means that the actual validation of paths needs to happen separately.

Variants

Dccp(u16)

Tuple Fields of Dccp

0: u16

Dns(Cow<'a, str>)

Tuple Fields of Dns

0: Cow<'a, str>

Dns4(Cow<'a, str>)

Tuple Fields of Dns4

0: Cow<'a, str>

Dns6(Cow<'a, str>)

Tuple Fields of Dns6

0: Cow<'a, str>

Dnsaddr(Cow<'a, str>)

Tuple Fields of Dnsaddr

0: Cow<'a, str>

Http

Https

Ip4(Ipv4Addr)

Tuple Fields of Ip4

0: Ipv4Addr

Ip6(Ipv6Addr)

Tuple Fields of Ip6

0: Ipv6Addr

P2pWebRtcDirect

P2pWebRtcStar

P2pWebSocketStar

Memory(u64)

Contains the “port” to contact. Similar to TCP or UDP, 0 means “assign me a port”.

Tuple Fields of Memory

0: u64

Onion(Cow<'a, [u8; 10]>, u16)

Tuple Fields of Onion

0: Cow<'a, [u8; 10]>1: u16

Onion3(Onion3Addr<'a>)

Tuple Fields of Onion3

0: Onion3Addr<'a>

P2p(Multihash)

Tuple Fields of P2p

0: Multihash

P2pCircuit

Quic

Sctp(u16)

Tuple Fields of Sctp

0: u16

Tcp(u16)

Tuple Fields of Tcp

0: u16

Udp(u16)

Tuple Fields of Udp

0: u16

Udt

Unix(Cow<'a, str>)

Tuple Fields of Unix

0: Cow<'a, str>

Utp

Ws(Cow<'a, str>)

Tuple Fields of Ws

0: Cow<'a, str>

Wss(Cow<'a, str>)

Tuple Fields of Wss

0: Cow<'a, str>

Implementations

impl<'a> Protocol<'a>

pub fn from_str_parts<I>(iter: I) -> Result<Self> where
    I: Iterator<Item = &'a str>, 

Parse a protocol value from the given iterator of string slices.

The parsing only consumes the minimum amount of string slices necessary to produce a well-formed protocol. The same iterator can thus be used to parse a sequence of protocols in succession. It is up to client code to check that iteration has finished whenever appropriate.

pub fn from_bytes(input: &'a [u8]) -> Result<(Self, &'a [u8])>

Parse a single Protocol value from its byte slice representation, returning the protocol as well as the remaining byte slice.

pub fn write_bytes<W: Write>(&self, w: &mut W) -> Result<()>

Encode this protocol by writing its binary representation into the given Write impl.

pub fn acquire<'b>(self) -> Protocol<'b>

Turn this Protocol into one that owns its data, thus being valid for any lifetime.

Trait Implementations

impl<'a> Clone for Protocol<'a>

fn clone(&self) -> Protocol<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Protocol<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Protocol<'a>

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

Formats the value using the given formatter.

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

fn from(addr: IpAddr) -> Self

Performs the conversion.

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

fn from(addr: Ipv4Addr) -> Self

Performs the conversion.

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

fn from(addr: Ipv6Addr) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

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

Creates a value from an iterator.

impl<'a> PartialEq<Protocol<'a>> for Protocol<'a>

fn eq(&self, other: &Protocol<'a>) -> bool

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

fn ne(&self, other: &Protocol<'a>) -> bool

This method tests for !=.

impl<'a> Eq for Protocol<'a>

impl<'a> StructuralEq for Protocol<'a>

impl<'a> StructuralPartialEq for Protocol<'a>