Struct kwap_msg::Message

pub struct Message<PayloadC: Collection<u8>, OptC: Collection<u8> + 'static, Opts: Collection<Opt<OptC>>> where
    for<'a> &'a PayloadC: IntoIterator<Item = &'a u8>,
    for<'a> &'a OptC: IntoIterator<Item = &'a u8>,
    for<'a> &'a Opts: IntoIterator<Item = &'a Opt<OptC>>,  {
    pub id: Id,
    pub ty: Type,
    pub ver: Version,
    pub token: Token,
    pub code: Code,
    pub opts: Opts,
    pub payload: Payload<PayloadC>,
    pub __optc: PhantomData<OptC>,
}

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::*;
let packet: Vec<u8> = /* bytes! */

// `VecMessage` uses `Vec` as the backing structure for byte buffers
let msg = VecMessage::try_from_bytes(packet.clone()).unwrap();
let mut opts_expected = /* create expected options */

let expected = VecMessage {
  id: Id(1),
  ty: Type(0),
  ver: Version(1),
  token: Token(tinyvec::array_vec!([u8; 8] => 254)),
  opts: opts_expected,
  code: Code {class: 2, detail: 5},
  payload: Payload(b"hello, world!".to_vec()),
  __optc: Default::default(),
};

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

token: Token

see Token for details

code: Code

see Code for details

opts: Opts

see opt::Opt for details

payload: Payload<PayloadC>

see Payload

__optc: PhantomData<OptC>

empty field using the Opt internal byte collection type

Trait Implementations

impl<PayloadC: Clone + Collection<u8>, OptC: Clone + Collection<u8> + 'static, Opts: Clone + Collection<Opt<OptC>>> Clone for Message<PayloadC, OptC, Opts> where
    for<'a> &'a PayloadC: IntoIterator<Item = &'a u8>,
    for<'a> &'a OptC: IntoIterator<Item = &'a u8>,
    for<'a> &'a Opts: IntoIterator<Item = &'a Opt<OptC>>, 

fn clone(&self) -> Message<PayloadC, OptC, Opts>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<PayloadC: Debug + Collection<u8>, OptC: Debug + Collection<u8> + 'static, Opts: Debug + Collection<Opt<OptC>>> Debug for Message<PayloadC, OptC, Opts> where
    for<'a> &'a PayloadC: IntoIterator<Item = &'a u8>,
    for<'a> &'a OptC: IntoIterator<Item = &'a u8>,
    for<'a> &'a Opts: IntoIterator<Item = &'a Opt<OptC>>, 

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

Formats the value using the given formatter.

impl<P: Collection<u8>, O: Collection<u8>, Os: Collection<Opt<O>>> GetSize for Message<P, O, Os> where
    for<'b> &'b P: IntoIterator<Item = &'b u8>,
    for<'b> &'b O: IntoIterator<Item = &'b u8>,
    for<'b> &'b Os: IntoIterator<Item = &'b Opt<O>>, 

fn get_size(&self) -> usize

Get the runtime size (in bytes) of a struct

fn max_size(&self) -> Option<usize>

Get the max size that this data structure can acommodate.

fn size_is_zero(&self) -> bool

Check if the runtime size is zero

fn is_full(&self) -> bool

Is there no room left in this collection?

impl<PayloadC: PartialEq + Collection<u8>, OptC: PartialEq + Collection<u8> + 'static, Opts: PartialEq + Collection<Opt<OptC>>> PartialEq<Message<PayloadC, OptC, Opts>> for Message<PayloadC, OptC, Opts> where
    for<'a> &'a PayloadC: IntoIterator<Item = &'a u8>,
    for<'a> &'a OptC: IntoIterator<Item = &'a u8>,
    for<'a> &'a Opts: IntoIterator<Item = &'a Opt<OptC>>, 

fn eq(&self, other: &Message<PayloadC, OptC, Opts>) -> bool

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

fn ne(&self, other: &Message<PayloadC, OptC, Opts>) -> bool

This method tests for !=.

impl<PayloadC: PartialOrd + Collection<u8>, OptC: PartialOrd + Collection<u8> + 'static, Opts: PartialOrd + Collection<Opt<OptC>>> PartialOrd<Message<PayloadC, OptC, Opts>> for Message<PayloadC, OptC, Opts> where
    for<'a> &'a PayloadC: IntoIterator<Item = &'a u8>,
    for<'a> &'a OptC: IntoIterator<Item = &'a u8>,
    for<'a> &'a Opts: IntoIterator<Item = &'a Opt<OptC>>, 

fn partial_cmp(&self, other: &Message<PayloadC, OptC, Opts>) -> 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, P: Collection<u8>, O: Collection<u8>, Os: Collection<Opt<O>>> TryFromBytes<&'a u8> for Message<P, O, Os> where
    for<'b> &'b P: IntoIterator<Item = &'b u8>,
    for<'b> &'b O: IntoIterator<Item = &'b u8>,
    for<'b> &'b Os: IntoIterator<Item = &'b Opt<O>>, 

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<P: Collection<u8>, O: Collection<u8>, Os: Collection<Opt<O>>> TryFromBytes<u8> for Message<P, O, Os> where
    for<'b> &'b P: IntoIterator<Item = &'b u8>,
    for<'b> &'b O: IntoIterator<Item = &'b u8>,
    for<'b> &'b Os: IntoIterator<Item = &'b Opt<O>>, 

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<P: Collection<u8>, O: Collection<u8>, Os: Collection<Opt<O>>> TryIntoBytes for Message<P, O, Os> where
    for<'b> &'b P: IntoIterator<Item = &'b u8>,
    for<'b> &'b O: IntoIterator<Item = &'b u8>,
    for<'b> &'b Os: IntoIterator<Item = &'b Opt<O>>, 

type Error = MessageToBytesError

fn try_into_bytes<C: Collection<u8>>(self) -> Result<C, Self::Error> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>, 

Try to convert into a collection of bytes

impl<PayloadC: Collection<u8>, OptC: Collection<u8> + 'static, Opts: Collection<Opt<OptC>>> StructuralPartialEq for Message<PayloadC, OptC, Opts> where
    for<'a> &'a PayloadC: IntoIterator<Item = &'a u8>,
    for<'a> &'a OptC: IntoIterator<Item = &'a u8>,
    for<'a> &'a Opts: IntoIterator<Item = &'a Opt<OptC>>,