Enum parity_multiaddr::Protocol

source · [−]

pub enum Protocol<'a> {
Show 26 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,
    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>),
}

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

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

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(Multihash)`

`P2pCircuit`

`Quic`

`Sctp(u16)`

`Tcp(u16)`

`Udp(u16)`

`Udt`

`Unix(Cow<'a, str>)`

`Utp`

`Ws(Cow<'a, str>)`

`Wss(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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

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

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 ==. Read more

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>

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

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.