Struct Message

pub struct Message<'data, const MAX_OPTION_COUNT: usize = { crate::DEFAULT_MAX_OPTION_COUNT }> { /* private fields */ }

A CoAP Message. Use this as a builder structure and then encode the message

Implementations

impl<'data, const MAX_OPTION_COUNT: usize> Message<'data, MAX_OPTION_COUNT>

pub fn new( message_type: Type, code: Code, message_id: u16, token: Token, options: Vec<CoapOption<'data>, MAX_OPTION_COUNT>, payload: Option<&'data [u8]>, ) -> Self

Initialize with minimum required message parameters.

The Message_Id and the Token are handled internally by CoAP-Zero. Options and a Payload are not required for a valid CoAP Message, but both can be set by the user if needed.

pub fn new_ack(message_id: u16) -> Self

Convenience constructor for empty ACKs (can not be used for piggybacked responses)

pub fn new_rst(message_id: u16) -> Self

Convenience constructor for RSTs

pub fn new_ping(message_id: u16) -> Self

Convenience constructor for pings

pub fn message_type(&self) -> Type

Returns the message type

pub fn code(&self) -> Code

Returns the message code

pub fn message_id(&self) -> u16

Returns the message ID

pub fn token(&self) -> Token

Returns the token

pub fn options(&self) -> &Vec<CoapOption<'_>, MAX_OPTION_COUNT>

Returns a reference to the options vector

pub fn payload(&self) -> Option<&'data [u8]>

Returns a reference to the payload, if any

pub fn is_empty(&self) -> bool

Returns true if the message code is Code::Empty

pub fn is_request(&self) -> bool

Returns true if the message has a code of Code::Request

pub fn is_response(&self) -> bool

Returns true if the message has a code of Code::Response

Trait Implementations

impl<'data, const MAX_OPTION_COUNT: usize> Clone for Message<'data, MAX_OPTION_COUNT>

fn clone(&self) -> Message<'data, MAX_OPTION_COUNT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data, const MAX_OPTION_COUNT: usize> Debug for Message<'data, MAX_OPTION_COUNT>

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

Formats the value using the given formatter.

impl<'data, const MAX_OPTION_COUNT: usize> PartialEq for Message<'data, MAX_OPTION_COUNT>

fn eq(&self, other: &Message<'data, MAX_OPTION_COUNT>) -> 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<'data, const MAX_OPTION_COUNT: usize> TryFrom<EncodedMessage<'data>> for Message<'data, MAX_OPTION_COUNT>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(encoded: EncodedMessage<'data>) -> Result<Self, Error>

Performs the conversion.

impl<'data, const MAX_OPTION_COUNT: usize> Eq for Message<'data, MAX_OPTION_COUNT>

impl<'data, const MAX_OPTION_COUNT: usize> StructuralPartialEq for Message<'data, MAX_OPTION_COUNT>