Struct MqttString 

pub struct MqttString(Box<str>);

An owned UTF-8 string that satisfies all MQTT v5 requirements.

This is the owned counterpart to MqttStr.

Tuple Fields

0: Box<str>

Implementations

impl MqttString

pub const fn as_mqtt_str(&self) -> &MqttStr

Returns a borrowed reference to the underlying MqttStr.

pub const fn as_str(&self) -> &str

Returns the underlying &str.

Methods from Deref<Target = MqttStr>

pub const EMPTY: &'static MqttStr

pub fn as_mqtt_bytes(&self) -> &MqttBytes

Returns this string as MqttBytes.

pub fn as_str(&self) -> &str

Returns the underlying &str.

pub fn len(&self) -> usize

Returns the length in bytes.

pub fn len_u16(&self) -> u16

Returns the length as a u16 for encoding.

pub fn encoded_len(&self) -> usize

Returns the number of bytes needed to encode this value.

pub fn is_empty(&self) -> bool

Returns true if the string is empty.

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

Returns the raw UTF-8 bytes.

Trait Implementations

impl AsRef<MqttStr> for MqttString

fn as_ref(&self) -> &MqttStr

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

impl AsRef<str> for MqttString

fn as_ref(&self) -> &str

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

impl Borrow<MqttStr> for MqttString

fn borrow(&self) -> &MqttStr

Immutably borrows from an owned value.

impl Clone for MqttString

fn clone(&self) -> MqttString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttString

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

Formats the value using the given formatter.

impl Deref for MqttString

type Target = MqttStr

The resulting type after dereferencing.

fn deref(&self) -> &MqttStr

Dereferences the value.

impl Display for MqttString

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

Formats the value using the given formatter.

impl FromStr for MqttString

type Err = DataError

The associated error which can be returned from parsing.

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

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

impl Hash for MqttString

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 MqttString

fn cmp(&self, other: &MqttString) -> 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 MqttString

fn eq(&self, other: &MqttString) -> 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 MqttString

fn partial_cmp(&self, other: &MqttString) -> 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 TryFrom<&str> for MqttString

type Error = DataError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<MqttString, <MqttString as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Box<str>> for MqttString

type Error = DataError

The type returned in the event of a conversion error.

fn try_from( s: Box<str>, ) -> Result<MqttString, <MqttString as TryFrom<Box<str>>>::Error>

Performs the conversion.

impl TryFrom<MqttString> for TopicBuf

type Error = TopicError

The type returned in the event of a conversion error.

fn try_from( value: MqttString, ) -> Result<TopicBuf, <TopicBuf as TryFrom<MqttString>>::Error>

Performs the conversion.

impl TryFrom<MqttString> for TopicFilterBuf

type Error = TopicError

The type returned in the event of a conversion error.

fn try_from( value: MqttString, ) -> Result<TopicFilterBuf, <TopicFilterBuf as TryFrom<MqttString>>::Error>

Performs the conversion.

impl TryFrom<String> for MqttString

type Error = DataError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for MqttString

impl StructuralPartialEq for MqttString