Struct Label

pub struct Label(/* private fields */);

General approach is to prefix all packets and streams with the same structure:

Encode:

  magic type byte (127): u8
  length of label name:  u8 (because labels can't be longer than 253 bytes)
  label name:            bytes (max 253 bytes)

Implementations

impl Label

pub const MAX_SIZE: usize = 253usize

The maximum size of a name in bytes.

pub const EMPTY: &'static Label

An empty label.

pub const fn empty() -> Label

Create an empty label.

pub fn encoded_overhead(&self) -> usize

The encoded overhead of a label.

pub fn from_static(s: &'static str) -> Result<Label, ParseLabelError>

Create a label from a static str.

pub fn as_bytes(&self) -> &[u8]

Returns the label as a byte slice.

pub fn as_str(&self) -> &str

Returns the str of the label.

pub fn is_empty(&self) -> bool

Returns true if the label is empty.

pub fn len(&self) -> usize

Returns the length of the label in bytes.

Trait Implementations

impl AsRef<str> for Label

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for Label

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl CheapClone for Label

fn cheap_clone(&self) -> Self

Returns a copy of the value.

impl Clone for Label

fn clone(&self) -> Label

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Data for Label

type Ref<'a> = &'a str

The reference type of the data.

fn from_ref(val: <Label as Data>::Ref<'_>) -> Result<Label, DecodeError>

where Label: Sized,

Converts the reference type to the owned type.

fn encoded_len(&self) -> usize

Returns the encoded length of the data only considering the data itself, (e.g. no length prefix, no wire type).

fn encode(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message to a buffer.

const WIRE_TYPE: WireType = WireType::LengthDelimited

The wire type of the data.

fn encoded_len_with_length_delimited(&self) -> usize

Returns the encoded length of the data including the length delimited.

fn encode_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Encodes the message into a vec.

fn encode_to_bytes(&self) -> Result<Bytes, EncodeError>

Encodes the message into a Bytes.

fn encode_length_delimited(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Encodes the message with a length-delimiter into a vec.

fn encode_length_delimited_to_bytes(&self) -> Result<Bytes, EncodeError>

Encodes the message with a length-delimiter into a Bytes.

fn decode(src: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from the buffer.

impl<'a> DataRef<'a, Label> for &'a str

fn decode(buf: &'a [u8]) -> Result<(usize, &'a str), DecodeError>

where &'a str: Sized,

Decodes the reference type from a buffer.

fn decode_length_delimited(src: &'a [u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited reference instance of the message from the buffer.

impl Debug for Label

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

Formats the value using the given formatter.

impl Default for Label

fn default() -> Label

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Label

fn deserialize<__D>( __deserializer: __D, ) -> Result<Label, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Label

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

Formats the value using the given formatter.

impl FromStr for Label

type Err = ParseLabelError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Label, <Label as FromStr>::Err>

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

impl Hash for Label

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Label

fn cmp(&self, other: &Label) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&String> for Label

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

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for Label

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

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for Label

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

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for Label

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

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Label

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

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Label

fn partial_cmp(&self, other: &Label) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Label

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Label

type Error = ParseLabelError

The type returned in the event of a conversion error.

fn try_from(s: &[u8]) -> Result<Label, <Label as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&String> for Label

type Error = ParseLabelError

The type returned in the event of a conversion error.

fn try_from(s: &String) -> Result<Label, <Label as TryFrom<&String>>::Error>

Performs the conversion.

impl TryFrom<&str> for Label

type Error = ParseLabelError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Label, <Label as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for Label

type Error = ParseLabelError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Label, <Label as TryFrom<String>>::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Label

type Error = ParseLabelError

The type returned in the event of a conversion error.

fn try_from(s: Vec<u8>) -> Result<Label, <Label as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

impl Eq for Label