Struct async_coap::message::OwnedImmutableMessage

pub struct OwnedImmutableMessage { /* fields omitted */ }

A class representing an immutable heap-allocated UDP CoAP message.

Methods

impl OwnedImmutableMessage

pub const MIN_MESSAGE_BUFFER_LEN: usize

The minimum size of a buffer that can be passed into new().

pub fn new(buffer: Vec<u8>) -> Result<OwnedImmutableMessage, Error>

Creates a new OwnedImmutableMessage instance with the given buffer.

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice containing the encoded message.

Trait Implementations

impl MessageRead for OwnedImmutableMessage

fn msg_code(&self) -> MsgCode

Gets the message code for this message.

fn msg_type(&self) -> MsgType

Gets the message type for this message.

fn msg_id(&self) -> u16

Gets the message id for this message.

fn msg_token(&self) -> MsgToken

Gets the message token for this message.

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

Gets the payload as a byte slice.

fn content_format(&self) -> Option<ContentFormat>

Indicates the content format of the payload, if specified.

fn accept(&self) -> Option<ContentFormat>

Indicates the content format that the sender of the message will accept for the payload of the response, if specified.

fn block2(&self) -> Option<BlockInfo>

Returns the value of the block2 option for this message, if any.

fn block1(&self) -> Option<BlockInfo>

Returns the value of the block1 option for this message, if any.

Important traits for OptionIterator<'a>

impl<'a> Iterator for OptionIterator<'a> type Item = Result<(OptionNumber, &'a [u8]), Error>;

fn options(&self) -> OptionIterator

Gets an iterator for processing the options of the message.

fn write_msg_to(&self, target: &mut dyn MessageWrite) -> Result<(), Error>

Writes this message to the given target that implements MessageWrite.

fn payload_as_str(&self) -> Option<&str>

Gets the payload as a string slice.

impl From<VecMessageEncoder> for OwnedImmutableMessage

fn from(x: VecMessageEncoder) -> Self

Performs the conversion.

impl PartialEq<OwnedImmutableMessage> for OwnedImmutableMessage

fn eq(&self, other: &OwnedImmutableMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OwnedImmutableMessage) -> bool

This method tests for !=.

impl Clone for OwnedImmutableMessage

fn clone(&self) -> OwnedImmutableMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for OwnedImmutableMessage

impl Display for OwnedImmutableMessage

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

Formats the value using the given formatter.

impl Debug for OwnedImmutableMessage

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

Formats the value using the given formatter.

impl<'a> Borrow<dyn MessageRead + 'a> for OwnedImmutableMessage

fn borrow(&self) -> &(dyn MessageRead + 'a)

Immutably borrows from an owned value.