Struct StringPairData 

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

A UTF-8 String Pair consists of two UTF-8 Encoded Strings.

This data type is used to hold name-value pairs. The first string serves as the name, and the second string contains the value.

Both strings MUST comply with the requirements for UTF-8 Encoded Strings [MQTT-1.5.7-1]. If a receiver (Client or Server) receives a string pair which does not meet these requirements it is a Malformed Packet.

+----------------------+
| Key Length           |
|                      |
+----------------------+
| Key characters       |
|                      |
+----------------------+
| Value Length         |
|                      |
+----------------------+
| Value characters     |
|                      |
+----------------------+

Implementations

impl StringPairData

pub fn new(key: &str, value: &str) -> Result<Self, EncodeError>

Create a new string pair.

Errors

Returns errors if key or value is too large.

pub const fn key(&self) -> &StringData

Get key in pair.

pub const fn value(&self) -> &StringData

Get string value in pari.

pub fn bytes(&self) -> usize

Get byte length in packet.

Trait Implementations

impl Clone for StringPairData

fn clone(&self) -> StringPairData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringPairData

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

Formats the value using the given formatter.

impl DecodePacket for StringPairData

fn decode(ba: &mut ByteArray<'_>) -> Result<Self, DecodeError>

Decode byte array into a mqtt packet.

impl Default for StringPairData

fn default() -> StringPairData

Returns the “default value” for a type.

impl Display for StringPairData

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

Formats the value using the given formatter.

impl EncodePacket for StringPairData

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

Encode packets into byte array.

impl PartialEq for StringPairData

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

impl StructuralPartialEq for StringPairData