Struct kwap_msg::alloc::Message

pub struct Message {
    pub id: Id,
    pub ty: Type,
    pub ver: Version,
    pub tkl: TokenLength,
    pub token: Token,
    pub code: Code,
    pub opts: Vec<Opt>,
    pub payload: Payload,
}

Low-level representation of a message that has been parsed from a byte array

To convert an iterator of bytes into a Message, there is a provided trait crate::TryFromBytes.

use kwap_msg::TryFromBytes;
use kwap_msg::alloc::*;
use kwap_msg::no_alloc;

let packet: Vec<u8> = /* bytes! */

// Heap allocated version from `kwap_msg::alloc`
let msg = Message::try_from_bytes(packet.clone()).unwrap();
let mut opts_expected = /* create expected options */

let expected = Message {
  id: Id(1),
  ty: Type(0),
  ver: Version(1),
  token: Token(254),
  tkl: TokenLength(1),
  opts: opts_expected,
  code: Code {class: 2, detail: 5},
  payload: Payload(b"hello, world!".to_vec()),
};

assert_eq!(msg, expected);

// Stack allocated version from `kwap_msg::no_alloc`
// respective capacities are:
// - the size of the message payload buffer (13)
// - number of options (1)
// - size of option value buffers (16)
let msg = no_alloc::Message::<13, 1, 16>::try_from_bytes(packet).unwrap();
let mut opts_expected = /* create expected options */

let expected = no_alloc::Message::<13, 1, 16> {
  id: Id(1),
  ty: Type(0),
  ver: Version(1),
  token: Token(254),
  tkl: TokenLength(1),
  opts: opts_expected,
  code: Code {class: 2, detail: 5},
  payload: no_alloc::Payload(b"hello, world!".into_iter().copied().collect()),
};

assert_eq!(msg, expected);

See RFC7252 - Message Details for context

Fields

id: Id

see Id for details

ty: Type

see Type for details

ver: Version

see Version for details

tkl: TokenLength

see TokenLength for details

token: Token

see Token for details

code: Code

see Code for details

opts: Vec<Opt>

see opt::Opt for details

payload: Payload

See Payload

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl From<Message> for Vec<u8>

fn from(msg: Message) -> Vec<u8>

Performs the conversion.

impl GetSize for Message

fn get_size(&self) -> usize

impl PartialEq<Message> for Message

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Message) -> bool

This method tests for !=.

impl PartialOrd<Message> for Message

fn partial_cmp(&self, other: &Message) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> TryFromBytes<&'a u8> for Message

type Error = MessageParseError

Error type yielded if conversion fails

fn try_from_bytes<I: IntoIterator<Item = &'a u8>>(
    bytes: I
) -> Result<Self, Self::Error>

Try to convert from some sequence of bytes T into Self

impl TryFromBytes<u8> for Message

type Error = MessageParseError

Error type yielded if conversion fails

fn try_from_bytes<I: IntoIterator<Item = u8>>(
    bytes: I
) -> Result<Self, Self::Error>

Try to convert from some sequence of bytes T into Self

impl StructuralPartialEq for Message