Struct CoapMessage

pub struct CoapMessage { /* private fields */ }

Representation of a CoAP message.

Implementations

impl CoapMessage

pub fn new(type_: CoapMessageType, code: CoapMessageCode) -> CoapMessage

Creates a new CoAP message with the given type and code.

pub unsafe fn from_raw_pdu( raw_pdu: *const coap_pdu_t, ) -> Result<CoapMessage, MessageConversionError>

Parses the given raw coap_pdu_t into a CoapMessage.

Safety

raw_pdu must point to a valid instance of coap_pdu_t.

pub fn into_raw_pdu<'a, S: CoapSessionCommon<'a> + ?Sized>( self, session: &S, ) -> Result<*mut coap_pdu_t, MessageConversionError>

Converts this message into a raw PDU suitable for sending using the raw coap_send() function.

The caller is responsible for freeing the returned PDU, either by calling coap_send() or [coap_delete_pdu()].

Trait Implementations

impl Clone for CoapMessage

fn clone(&self) -> CoapMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CoapMessageCommon for CoapMessage

fn as_message(&self) -> &CoapMessage

Returns a reference to this message.

fn as_message_mut(&mut self) -> &mut CoapMessage

Returns a mutable reference to this message.

fn add_option(&mut self, option: CoapOption)

Add the supplied CoAP option to this message.

fn clear_options(&mut self)

Clear the list of options that were added to this message using add_option().

fn options_iter(&self) -> Iter<'_, CoapOption>

Returns an iterator over the options contained in this message.

fn type_(&self) -> CoapMessageType

Returns the CoAP message type (confirmable, non-confirmable, acknowledgement, rst) of this message.

fn set_type_(&mut self, type_: CoapMessageType)

Sets the CoAP message type (confirmable, non-confirmable, acknowledgement, rst) of this message.

fn code(&self) -> CoapMessageCode

Returns the message code of this message. To determine whether the message is a request or response, use CoapMessageCode::try_from() and match for the enum variants.

fn set_code<C: Into<CoapMessageCode>>(&mut self, code: C)

Sets the message code of this message.

fn mid(&self) -> Option<CoapMessageId>

Returns the CoAP message ID for this message.

fn set_mid(&mut self, mid: Option<CoapMessageId>)

Sets the CoAP message ID for this message.

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

Returns a reference to the data/body of this message.

fn set_data<D: Into<Box<[u8]>>>(&mut self, data: Option<D>)

Sets the data/body of this message.

fn token(&self) -> Option<&[u8]>

Returns the message token.

fn set_token<D: Into<Box<[u8]>>>(&mut self, token: Option<D>)

Sets the message token.

impl Debug for CoapMessage

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

Formats the value using the given formatter.

impl From<CoapRequest> for CoapMessage

fn from(val: CoapRequest) -> Self

Converts to this type from the input type.

impl From<CoapResponse> for CoapMessage

fn from(val: CoapResponse) -> Self

Converts to this type from the input type.

impl Hash for CoapMessage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CoapMessage

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

impl StructuralPartialEq for CoapMessage