Struct MqttSnLayer 

pub struct MqttSnLayer {
    pub index: LayerIndex,
}

MQTT-SN layer – a zero-copy view into a packet buffer.

Fields

index: LayerIndex

Implementations

impl MqttSnLayer

pub fn new(index: LayerIndex) -> Self

Create a new MQTT-SN layer from a layer index.

pub fn packet_length(&self, buf: &[u8]) -> Result<u16, FieldError>

Get the total packet length (as encoded in the length field).

pub fn msg_type(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the message type byte.

pub fn flags(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the raw flags byte. Returns an error if this message type has no flags.

pub fn dup(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the DUP flag (bit 7 of flags byte).

pub fn qos(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the QoS level (bits 6-5 of flags byte).

pub fn retain(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the RETAIN flag (bit 4 of flags byte).

pub fn will(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the WILL flag (bit 3 of flags byte).

pub fn cleansess(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the CleanSession flag (bit 2 of flags byte).

pub fn tid_type(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the topic ID type (bits 1-0 of flags byte).

pub fn gw_id(&self, buf: &[u8]) -> Result<u8, FieldError>

Get gateway ID (ADVERTISE, GWINFO).

pub fn duration(&self, buf: &[u8]) -> Result<u16, FieldError>

Get duration field (ADVERTISE: offset body+1, CONNECT: offset body+flags+prot_id, DISCONNECT: offset body+0 (optional)).

pub fn radius(&self, buf: &[u8]) -> Result<u8, FieldError>

Get radius (SEARCHGW).

pub fn gw_addr<'a>(&self, buf: &'a [u8]) -> Result<&'a [u8], FieldError>

Get gateway address bytes (GWINFO, after gw_id).

pub fn prot_id(&self, buf: &[u8]) -> Result<u8, FieldError>

Get protocol ID (CONNECT, after flags byte).

pub fn client_id<'a>(&self, buf: &'a [u8]) -> Result<&'a str, FieldError>

Get client ID string (CONNECT, PINGREQ).

pub fn return_code(&self, buf: &[u8]) -> Result<u8, FieldError>

Get return code (CONNACK, REGACK, PUBACK, SUBACK, WILLTOPICRESP, WILLMSGRESP).

pub fn tid(&self, buf: &[u8]) -> Result<u16, FieldError>

Get topic ID (REGISTER, REGACK, PUBLISH, PUBACK, SUBSCRIBE/UNSUBSCRIBE, SUBACK).

pub fn mid(&self, buf: &[u8]) -> Result<u16, FieldError>

Get message ID (REGISTER, REGACK, PUBLISH, PUBACK, PUBCOMP, PUBREC, PUBREL, SUBSCRIBE, SUBACK, UNSUBSCRIBE, UNSUBACK).

pub fn data<'a>(&self, buf: &'a [u8]) -> Result<&'a [u8], FieldError>

Get publish data payload (PUBLISH, after flags+tid+mid).

pub fn topic_name<'a>(&self, buf: &'a [u8]) -> Result<&'a str, FieldError>

Get topic name (REGISTER, SUBSCRIBE/UNSUBSCRIBE with TID_NORMAL).

pub fn will_topic<'a>(&self, buf: &'a [u8]) -> Result<&'a str, FieldError>

Get will topic (WILLTOPIC, WILLTOPICUPD).

pub fn will_msg<'a>(&self, buf: &'a [u8]) -> Result<&'a [u8], FieldError>

Get will message (WILLMSG, WILLMSGUPD).

pub fn set_msg_type(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the message type byte in the buffer.

pub fn set_flags(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the flags byte in the buffer.

pub fn field_names() -> &'static [&'static str]

Get the field names for this layer.

pub fn get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.

pub fn set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.

Trait Implementations

impl Clone for MqttSnLayer

fn clone(&self) -> MqttSnLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttSnLayer

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

Formats the value using the given formatter.

impl From<MqttSnLayer> for LayerEnum

fn from(v: MqttSnLayer) -> LayerEnum

Converts to this type from the input type.

impl Layer for MqttSnLayer

fn kind(&self) -> LayerKind

Get the kind of this layer

fn summary(&self, data: &[u8]) -> String

Get a human-readable summary of this layer

fn header_len(&self, data: &[u8]) -> usize

Get the header length for this layer

fn field_names(&self) -> &'static [&'static str]

Get the list of field names for this layer

fn hashret(&self, _data: &[u8]) -> Vec<u8>

Compute a hash for packet matching.

fn answers(&self, _data: &[u8], _other: &Self, _other_data: &[u8]) -> bool

Check if this packet answers another packet.

fn extract_padding<'a>(&self, data: &'a [u8]) -> (&'a [u8], &'a [u8])

Extract padding from the packet.

impl LayerDispatch for MqttSnLayer

fn dispatch_kind(&self) -> LayerKind

Get the kind of this layer.

fn dispatch_index(&self) -> &LayerIndex

Get the layer index (start/end offsets).

fn dispatch_summary(&self, buf: &[u8]) -> String

Get a human-readable summary.

fn dispatch_header_len(&self, buf: &[u8]) -> usize

Get the header length in bytes.

fn dispatch_hashret(&self, buf: &[u8]) -> Vec<u8>

Compute a hash for packet matching.

fn dispatch_field_names(&self) -> &'static [&'static str]

Get field names for this layer type.

fn dispatch_get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.

fn dispatch_set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.

fn dispatch_show_fields(&self, buf: &[u8]) -> Vec<(&'static str, String)>

Get show-fields output.

impl TryInto<MqttSnLayer> for LayerEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<MqttSnLayer, <Self as TryInto<MqttSnLayer>>::Error>

Performs the conversion.