Struct HeapMessage

pub struct HeapMessage { /* private fields */ }

Available on crate feature alloc only.

A heap CoAP message backed by allocated memory

It stores its payload in a Vec, and uses a BTreeMap<_, Vec<_>> to store all the individual option values.

It offers a few methods for direct manipulation of options, even out of sequence, that can not be expected from a general message buffer and are thus not captured in traits.

use coap_message::{MinimalWritableMessage, ReadableMessage};
let mut m = HeapMessage::new();
m.set_code(1);
m.add_option(11, b".well-known");
m.add_option(11, b"core");

let mut m2 = HeapMessage::new();
m2.set_from_message(&m);
assert!(m.code() == 1);

Implementations

impl HeapMessage

pub fn new() -> Self

pub fn change_option( &mut self, optnum: u16, occurrence: usize, value: impl Into<Vec<u8>>, )

Replace the occurrence’th value of the optnum option in the message

Panics if there’s not occurrence + 1 options of that number.

pub fn remove_option(&mut self, optnum: u16, occurrence: usize)

Remove the occurrence’th option of option number optnum

Panics if there’s not occurrence + 1 options of that number.

Trait Implementations

impl Debug for HeapMessage

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

Formats the value using the given formatter.

impl MinimalWritableMessage for HeapMessage

type AddOptionError = Infallible

Error returned when an option can not be added (eg. for lack of space, or because an option of a higher number or even the payload was already set)

type SetPayloadError = Infallible

Error returned when setting the payload (eg. for lack of space, or when a message of that type does not take a payload)

type UnionError = Infallible

Error type into which either of the other errors, as well as the errors for conversion of the Code and OptionNumber, can be .into()ed.

type Code = u8

See Self::set_code()

type OptionNumber = u16

See Self::add_option()

fn set_code(&mut self, code: u8)

Set the CoAP code of the message (in a request, that is the request method)

fn add_option(&mut self, optnum: u16, data: &[u8]) -> Result<(), Infallible>

Add an option to the message

fn set_payload(&mut self, payload: &[u8]) -> Result<(), Infallible>

Set the payload to the message

fn set_from_message<M>(&mut self, msg: &M) -> Result<(), Self::UnionError>

where M: ReadableMessage + WithSortedOptions,

Copy code, options and payload in from a readable message

fn add_option_str( &mut self, number: Self::OptionNumber, value: &str, ) -> Result<(), Self::AddOptionError>

Shortcut for add_option(self, number, value.as_bytes()).

fn add_option_uint<U>( &mut self, number: Self::OptionNumber, value: U, ) -> Result<(), Self::AddOptionError>

where U: Unsigned + ToBytes,

Shortcut for add_option on a buffer containing the uint encoded value

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

Type ID of Self or a ’static version of Self

fn promote_to_mutable_writable_message( &mut self, ) -> Option<&mut (impl MinimalWritableMessage<Code = Self::Code, OptionNumber = Self::OptionNumber, AddOptionError = Self::AddOptionError, SetPayloadError = Self::SetPayloadError, UnionError = Self::UnionError> + MutableWritableMessage)>

Tries to obtain a MutableWritableMessage from self.

fn convert_code_error(e: <Self::Code as Code>::Error) -> Self::UnionError

Auxiliary function for converting Self::Code::Error

fn convert_option_number_error( e: <Self::OptionNumber as OptionNumber>::Error, ) -> Self::UnionError

Auxiliary function for converting Self::OptionNumber::Error

fn convert_add_option_error(e: Self::AddOptionError) -> Self::UnionError

Auxiliary function for converting Self::AddOptionError

fn convert_set_payload_error(e: Self::SetPayloadError) -> Self::UnionError

Auxiliary function for converting Self::SetPayloadError

impl MutableWritableMessage for HeapMessage

fn available_space(&self) -> usize

Number of bytes available for additional options, payload marker and payload

fn payload_mut_with_len(&mut self, len: usize) -> Result<&mut [u8], Infallible>

Memory-map len bytes of the payload for writing

fn truncate(&mut self, len: usize) -> Result<(), Infallible>

Truncate an already-set payload to the given length; that payload must have been written to before using MinimalWritableMessage::set_payload, or with a suitable MutableWritableMessage::payload_mut_with_len call.

fn mutate_options<F>(&mut self, callback: F)

where F: FnMut(Self::OptionNumber, &mut [u8]),

Apply a callback to all options in sequence

impl ReadableMessage for HeapMessage

type Code = u8

See Self::code()

type MessageOption<'a> = MessageOption<'a>

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

type OptionsIter<'a> = ReadCursor<'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<'m>(&'m self) -> ReadCursor<'m>

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

impl SeekWritableMessage for HeapMessage

impl WithSortedOptions for HeapMessage