Trait ockam_multiaddr::Protocol

pub trait Protocol<'a>: Sized {
    const CODE: Code;
    const PREFIX: &'static str;

    // Required methods
    fn read_str(input: Checked<&'a str>) -> Result<Self, Error>;
    fn write_str(&self, f: &mut Formatter<'_>) -> Result<(), Error>;
    fn read_bytes(input: Checked<&'a [u8]>) -> Result<Self, Error>;
    fn write_bytes(&self, buf: &mut dyn Buffer);
}

Component of a MultiAddr.

A protocol supports a textual and a binary representation.

Protocol <- Text / Binary
Text     <- '/' Prefix '/' Char+
Prefix   <- Char+
Binary   <- Code Byte+
Code     <- UnsignedVarint

To process a protocol, one needs to know the code and prefix as they determine the protocol value.

NB: Protocol values which contain ’/’s create ambiguity in the textual representation. These so called “path protocols” must be the last protocol component in a multi-address.

Required Associated Constants

const CODE: Code

Registered protocol code.

const PREFIX: &'static str

Registered protocol prefix.

Required Methods

fn read_str(input: Checked<&'a str>) -> Result<Self, Error>

Parse the string value of this protocol.

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

Write the protocol as a string, including the prefix.

fn read_bytes(input: Checked<&'a [u8]>) -> Result<Self, Error>

Decode the binary value of this protocol.

fn write_bytes(&self, buf: &mut dyn Buffer)

Write the protocol as a binary value, including the code.

Object Safety

This trait is not object safe.

Implementors

impl Protocol<'_> for Ip4

const CODE: Code = _

const PREFIX: &'static str = "ip4"

impl Protocol<'_> for Ip6

const CODE: Code = _

const PREFIX: &'static str = "ip6"

impl Protocol<'_> for Tcp

const CODE: Code = _

const PREFIX: &'static str = "tcp"

impl<'a> Protocol<'a> for DnsAddr<'a>

const CODE: Code = _

const PREFIX: &'static str = "dnsaddr"

impl<'a> Protocol<'a> for Node<'a>

const CODE: Code = _

const PREFIX: &'static str = "node"

impl<'a> Protocol<'a> for Project<'a>

const CODE: Code = _

const PREFIX: &'static str = "project"

impl<'a> Protocol<'a> for Secure<'a>

const CODE: Code = _

const PREFIX: &'static str = "secure"

impl<'a> Protocol<'a> for Service<'a>

const CODE: Code = _

const PREFIX: &'static str = "service"

impl<'a> Protocol<'a> for Space<'a>

const CODE: Code = _

const PREFIX: &'static str = "space"

impl<'a> Protocol<'a> for Worker<'a>

const CODE: Code = _

const PREFIX: &'static str = "worker"