Struct Label

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

Labels are always stored as ASCII, unicode characters must be encoded with punycode

Implementations

impl Label

pub fn from_raw_bytes(bytes: &[u8]) -> Result<Label, ProtoError>

These must only be ASCII, with unicode encoded to PunyCode, or other such transformation.

This uses the bytes as raw ascii values, with nothing escaped on the wire. Generally users should use from_str or from_ascii

pub fn from_utf8(s: &str) -> Result<Label, ProtoError>

Translates this string into IDNA safe name, encoding to punycode as necessary.

pub fn from_ascii(s: &str) -> Result<Label, ProtoError>

Takes the ascii string and returns a new label.

This will return an Error if the label is not an ascii string

pub fn wildcard() -> Label

Returns a new Label of the Wildcard, i.e. “*”

pub fn to_lowercase(&self) -> Label

Converts this label to lowercase

pub fn is_wildcard(&self) -> bool

Returns true if this label is the wildcard, ‘*’, label

pub fn len(&self) -> usize

Returns the length in bytes of this label

pub fn is_empty(&self) -> bool

True if the label contains no characters

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

Returns the raw bytes of the label, this is good for writing to the wire.

See Display for presentation version (unescaped from punycode, etc)

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

Performs the equivalence operation disregarding case

pub fn cmp_with_f<F>(&self, other: &Label) -> Ordering

where F: LabelCmp,

compares with the other label, ignoring case

pub fn to_utf8(&self) -> String

Performs the conversion to utf8 from IDNA as necessary, see fmt for more details

pub fn to_ascii(&self) -> String

Converts this label to safe ascii, escaping characters as necessary

If this is an IDNA, punycode, label, then the xn– prefix will be maintained as ascii

pub fn write_ascii<W>(&self, f: &mut W) -> Result<(), Error>

where W: Write,

Writes this label to safe ascii, escaping characters as necessary

Trait Implementations

impl AsRef<[u8]> for Label

fn as_ref(&self) -> &[u8]

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

impl Borrow<[u8]> for Label

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Clone for Label

fn clone(&self) -> Label

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl Display for Label

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

outputs characters in a safe string manner.

if the string is punycode, i.e. starts with xn--, otherwise it translates to a safe ascii string escaping characters as necessary.

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 IntoLabel for &Label

fn into_label(self) -> Result<Label, ProtoError>

Convert this into Label

impl IntoLabel for Label

fn into_label(self) -> Result<Label, ProtoError>

Convert this into Label

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 for Label

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

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

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 Eq for Label