Struct coap_message::heapmessage::HeapMessage

pub struct HeapMessage { /* private fields */ }

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.

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.

pub fn add_option(&mut self, optnum: u16, data: &[u8])

Like MinimalWritableMessage::add_option, but allowing arbitrary access

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 Code = u8

type OptionNumber = u16

fn set_code(&mut self, code: u8)

fn add_option(&mut self, optnum: u16, data: &[u8])

Add an option to the message

fn set_payload(&mut self, payload: &[u8])

fn set_from_message<M>(&mut self, msg: &M) where
    M: ReadableMessage, 

Copy code, options and payload in from a readable message

fn add_option_str(&mut self, number: Self::OptionNumber, value: &str)

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

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

Shortcut for add_option on a buffer containing the uint encoded value

impl MutableWritableMessage for HeapMessage

fn available_space(&self) -> usize

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

fn payload_mut(&mut self) -> &mut [u8]

👎 Deprecated since 0.1.1:

Use payload_mut_with_len instead

Legacy method for mutable access to the payload

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

Memory-map len bytes of the payload for writing

fn truncate(&mut self, len: usize)

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 code; also used with MinimalWritableMessage::set_code()

type MessageOption = MessageOption<'a>

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

type OptionsIter = ReadCursor<'a>

See 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

impl WithSortedOptions for HeapMessage