Enum multiaddr::Protocol

source ·
#[non_exhaustive]
pub enum Protocol<'a> {
Show 32 variants 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, WebRTCDirect, Certhash(Multihash<64>), P2pWebSocketStar, Memory(u64), Onion(Cow<'a, [u8; 10]>, u16), Onion3(Onion3Addr<'a>), P2p(PeerId), P2pCircuit, Quic, QuicV1, Sctp(u16), Tcp(u16), Tls, Noise, Udp(u16), Udt, Unix(Cow<'a, str>), Utp, WebTransport, Ws(Cow<'a, str>), Wss(Cow<'a, str>),
}
Expand description

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 (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

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

§

WebRTCDirect

§

Certhash(Multihash<64>)

§

P2pWebSocketStar

§

Memory(u64)

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

§

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

§

Onion3(Onion3Addr<'a>)

§

P2p(PeerId)

§

P2pCircuit

§

Quic

§

QuicV1

§

Sctp(u16)

§

Tcp(u16)

§

Tls

§

Noise

§

Udp(u16)

§

Udt

§

Unix(Cow<'a, str>)

§

Utp

§

WebTransport

§

Ws(Cow<'a, str>)

§

Wss(Cow<'a, str>)

Implementations§

source§

impl<'a> Protocol<'a>

source

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.

source

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.

source

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

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

source

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

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

source

pub fn tag(&self) -> &'static str

Trait Implementations§

source§

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

source§

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

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<'a> Debug for Protocol<'a>

source§

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

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

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

source§

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

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

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

source§

fn from(addr: IpAddr) -> Self

Converts to this type from the input type.
source§

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

source§

fn from(addr: Ipv4Addr) -> Self

Converts to this type from the input type.
source§

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

source§

fn from(addr: Ipv6Addr) -> Self

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<'a> PartialEq for Protocol<'a>

source§

fn eq(&self, other: &Protocol<'a>) -> 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<'a> Eq for Protocol<'a>

source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Protocol<'a>

§

impl<'a> Send for Protocol<'a>

§

impl<'a> Sync for Protocol<'a>

§

impl<'a> Unpin for Protocol<'a>

§

impl<'a> UnwindSafe for Protocol<'a>

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