Struct MqttBinary 

pub struct MqttBinary<'b>(/* private fields */);

Arbitrary binary data with a length less than or equal to MqttBinary::MAX_LENGTH (u16::MAX). Exceeding this size ultimately leads to malformed packets.

Examples

use rust_mqtt::Bytes;
use rust_mqtt::types::{MqttBinary, MqttString, TooLargeToEncode};

let slice = [0x00; MqttBinary::MAX_LENGTH];
let too_long = [0x00; MqttBinary::MAX_LENGTH + 1];

let b = MqttBinary::from_slice(&slice)?;
assert_eq!(b.as_bytes(), &slice);
assert!(MqttBinary::from_slice(&too_long).is_err());

let b = MqttBinary::from_bytes(Bytes::Borrowed(&slice))?;
assert_eq!(b.as_bytes(), &slice);
assert!(MqttBinary::from_bytes(Bytes::Borrowed(&too_long)).is_err());

let from_slice_unchecked = MqttBinary::from_slice_unchecked(&slice);
assert_eq!(from_slice_unchecked.as_bytes(), &slice);

let from_bytes_unchecked = MqttBinary::from_bytes_unchecked(Bytes::Borrowed(&slice));
assert_eq!(from_bytes_unchecked.as_bytes(), &slice);

Implementations

impl<'b> MqttBinary<'b>

pub const MAX_LENGTH: usize

The maximum length of binary data so that it can be encoded. This value is limited by the 2-byte length field.

pub fn from_bytes(bytes: Bytes<'b>) -> Result<Self, TooLargeToEncode>

Converts Bytes into MqttBinary by checking for the max length of MqttBinary::MAX_LENGTH.

Errors

Returns TooLargeToEncode if bytes’ length exceeds MqttBinary::MAX_LENGTH.

pub const fn from_slice(slice: &'b [u8]) -> Result<Self, TooLargeToEncode>

Converts a slice into MqttBinary by cloning the reference and checking for the max length of MqttBinary::MAX_LENGTH.

Errors

Returns TooLargeToEncode if slice’s length exceeds MqttBinary::MAX_LENGTH.

pub const fn from_bytes_unchecked(bytes: Bytes<'b>) -> Self

Converts Bytes into MqttBinary without checking for the max length of MqttBinary::MAX_LENGTH.

Invariants

The length of the slice parameter in bytes is less than or equal to MqttBinary::MAX_LENGTH.

Panics

In debug builds, this function will panic if the bytes’ length is greater than MqttBinary::MAX_LENGTH.

pub const fn from_slice_unchecked(slice: &'b [u8]) -> Self

Converts a slice into MqttBinary without checking for the max length of MqttBinary::MAX_LENGTH.

Invariants

The length of the slice parameter in bytes is less than or equal to MqttBinary::MAX_LENGTH.

Panics

In debug builds, this function will panic if the slice’s length is greater than MqttBinary::MAX_LENGTH.

pub const fn len(&self) -> u16

Returns the length of the underlying data.

pub const fn is_empty(&self) -> bool

Returns whether the underlying data is empty.

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

Returns the underlying bytes as &[u8]

pub const fn as_borrowed(&'b self) -> Self

Delegates to Bytes::as_borrowed.

Trait Implementations

impl AsRef<[u8]> for MqttBinary<'_>

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

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

impl<'b> Clone for MqttBinary<'b>

fn clone(&self) -> MqttBinary<'b>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttBinary<'_>

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

Formats the value using the given formatter.

impl<'b> Default for MqttBinary<'b>

fn default() -> MqttBinary<'b>

Returns the “default value” for a type.

impl<'b> From<MqttString<'b>> for MqttBinary<'b>

fn from(value: MqttString<'b>) -> Self

Converts to this type from the input type.

impl<'b> PartialEq for MqttBinary<'b>

fn eq(&self, other: &MqttBinary<'b>) -> 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<'b> TryFrom<&'b [u8]> for MqttBinary<'b>

type Error = TooLargeToEncode

The type returned in the event of a conversion error.

fn try_from(value: &'b [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'b> TryFrom<&'b str> for MqttBinary<'b>

type Error = TooLargeToEncode

The type returned in the event of a conversion error.

fn try_from(value: &'b str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'s> TryFrom<MqttBinary<'s>> for MqttString<'s>

type Error = MqttStringError

The type returned in the event of a conversion error.

fn try_from(value: MqttBinary<'s>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'b> Eq for MqttBinary<'b>

impl<'b> StructuralPartialEq for MqttBinary<'b>