Struct Message

pub struct Message<'a> { /* private fields */ }

A CoAP message that resides in contiguous readable memory

This implementation does not attempt to do any early validation. On encoding errors discovered at runtime, it simply emits the critical-and-not-safe-to-forward CoAP option 65535 (OPTION_INVALID), which to the indication indicates that something went wrong

Message is covariant over its lifetime because it only reads from there. FIXME: It should express that using a Deref or something like that.

Implementation details

When used with coap_message::helpers::RefWithStaticType, it always uses its 'static counterpart as the corresponding type ID. Its Self::downcast_from method uses this, and restores the lifetime based on the given impl Trait reference’s lifetime using its covariance property.

Implementations

impl<'a> Message<'a>

pub fn new(code: u8, options_and_payload: &'a [u8]) -> Self

pub fn downcast_from<M: ReadableMessage>(generic: &'a M) -> Option<&'a Self>

Available on crate feature downcast only.

Trait Implementations

impl<'a> Clone for Message<'a>

fn clone(&self) -> Message<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'m> ReadableMessage for Message<'m>

type Code = u8

See Self::code()

type MessageOption<'a> = MessageOption<'a> where Self: 'a

Type of an individual option, indiciating its option number and value

type OptionsIter<'a> = OptionsIter<'a> where Self: 'a

See Self::options()

fn code(&self) -> u8

Get the code (request method or response code) of the message

fn payload(&self) -> &[u8]

Get the payload set in the message

fn options(&self) -> OptionsIter<'_>

Produce all options in arbitrary order as an iterator

fn with_static_type_annotation(&self) -> Option<RefWithStaticType<'_, Self>>

Type ID of Self or a ’static version of Self