Enum multiaddr::Protocol

#[repr(u32)]
pub enum Protocol {
    IP4,
    TCP,
    UDP,
    DCCP,
    IP6,
    DNS4,
    DNS6,
    SCTP,
    UDT,
    UTP,
    UNIX,
    P2P,
    IPFS,
    HTTP,
    HTTPS,
    ONION,
    QUIC,
    WS,
    WSS,
    Libp2pWebsocketStar,
    Libp2pWebrtcStar,
    Libp2pWebrtcDirect,
    P2pCircuit,
}

Protocol

A type to describe the possible protocol used in a Multiaddr. Protocol is the list of all possible protocols.

Variants

IP4TCPUDPDCCPIP6DNS4DNS6SCTPUDTUTPUNIXP2PIPFSHTTPHTTPSONIONQUICWSWSSLibp2pWebsocketStarLibp2pWebrtcStarLibp2pWebrtcDirectP2pCircuit

Methods

impl Protocol

pub fn from(raw: u64) -> Result<Protocol>

Convert a u64 based code to a Protocol.

Examples

use multiaddr::Protocol;

assert_eq!(Protocol::from(6).unwrap(), Protocol::TCP);
assert!(Protocol::from(455).is_err());

pub fn size(self) -> ProtocolArgSize

Get the size from a Protocol.

Examples

use multiaddr::Protocol;
use multiaddr::ProtocolArgSize;

assert_eq!(Protocol::TCP.size(), ProtocolArgSize::Fixed { bytes: 2 });

impl Protocol

pub fn parse_data(&self, a: &str) -> Result<AddrComponent>

Convert an array slice to the string representation.

Examples

use std::net::Ipv4Addr;
use multiaddr::AddrComponent;
use multiaddr::Protocol;

let proto = Protocol::IP4;
assert_eq!(proto.parse_data("127.0.0.1").unwrap(),
           AddrComponent::IP4(Ipv4Addr::new(127, 0, 0, 1)));

Trait Implementations

impl PartialEq<Protocol> for Protocol

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Protocol

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Protocol> for u32

fn from(proto: Protocol) -> u32

Performs the conversion.

impl From<Protocol> for u64

fn from(proto: Protocol) -> u64

Performs the conversion.

impl Copy for Protocol

impl Display for Protocol

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

Formats the value using the given formatter.

impl Debug for Protocol

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

Formats the value using the given formatter.

impl FromStr for Protocol

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.