Struct OwnedImmutableMessage

pub struct OwnedImmutableMessage { /* private fields */ }

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

Implementations

impl OwnedImmutableMessage

pub const MIN_MESSAGE_BUFFER_LEN: usize = 4usize

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<'a> Borrow<dyn MessageRead + 'a> for OwnedImmutableMessage

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

Immutably borrows from an owned value.

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 Debug for OwnedImmutableMessage

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

Formats the value using the given formatter.

impl Display for OwnedImmutableMessage

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

Formats the value using the given formatter.

impl From<VecMessageEncoder> for OwnedImmutableMessage

fn from(x: VecMessageEncoder) -> Self

Converts to this type from the input type.

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.

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 PartialEq for OwnedImmutableMessage

fn eq(&self, other: &OwnedImmutableMessage) -> 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<SD, IC> SendDesc<IC, OwnedImmutableMessage> for EmitAnyResponse<SD>

where SD: SendDesc<IC, ()> + Send, IC: InboundContext,

fn delay_to_retransmit(&self, retransmits_sent: u32) -> Option<Duration>

Calculates the duration of the delay to wait before sending the next retransmission.

fn delay_to_restart(&self) -> Option<Duration>

The delay to wait between when we have received a successful response and when we should send out another request.

fn max_rtt(&self) -> Duration

The maximum time to wait for an asynchronous response after having received an ACK.

fn transmit_wait_duration(&self) -> Duration

the maximum time from the first transmission of a Confirmable message to the time when the sender gives up on receiving an acknowledgement or reset.

fn write_options( &self, msg: &mut dyn OptionInsert, socket_addr: &IC::SocketAddr, start: Bound<OptionNumber>, end: Bound<OptionNumber>, ) -> Result<(), Error>

Defines which options are going to be included in the outbound message.

fn write_payload( &self, msg: &mut dyn MessageWrite, socket_addr: &IC::SocketAddr, ) -> Result<(), Error>

Generates the outbound message by making calls into msg.

fn supports_option(&self, option: OptionNumber) -> bool

Experimental: Used for determining if the given option seen in the reply message is supported or not.

fn handler( &mut self, context: Result<&IC, Error>, ) -> Result<ResponseStatus<OwnedImmutableMessage>, Error>

Handles the response to the outbound message.

fn trans_params(&self) -> Option<TP>

Experimental: Gets custom transmission parameters.

impl<SD, IC> SendDesc<IC, OwnedImmutableMessage> for EmitSuccessfulResponse<SD>

where SD: SendDesc<IC, ()> + Send, IC: InboundContext,

fn delay_to_retransmit(&self, retransmits_sent: u32) -> Option<Duration>

Calculates the duration of the delay to wait before sending the next retransmission.

fn delay_to_restart(&self) -> Option<Duration>

The delay to wait between when we have received a successful response and when we should send out another request.

fn max_rtt(&self) -> Duration

The maximum time to wait for an asynchronous response after having received an ACK.

fn transmit_wait_duration(&self) -> Duration

the maximum time from the first transmission of a Confirmable message to the time when the sender gives up on receiving an acknowledgement or reset.

fn write_options( &self, msg: &mut dyn OptionInsert, socket_addr: &IC::SocketAddr, start: Bound<OptionNumber>, end: Bound<OptionNumber>, ) -> Result<(), Error>

Defines which options are going to be included in the outbound message.

fn write_payload( &self, msg: &mut dyn MessageWrite, socket_addr: &IC::SocketAddr, ) -> Result<(), Error>

Generates the outbound message by making calls into msg.

fn supports_option(&self, option: OptionNumber) -> bool

Experimental: Used for determining if the given option seen in the reply message is supported or not.

fn handler( &mut self, context: Result<&IC, Error>, ) -> Result<ResponseStatus<OwnedImmutableMessage>, Error>

Handles the response to the outbound message.

fn trans_params(&self) -> Option<TP>

Experimental: Gets custom transmission parameters.

impl<SD, IC> SendDesc<IC, OwnedImmutableMessage> for UnicastBlock2Collect<SD, IC>

where SD: SendDesc<IC, ()> + Send + SendDescUnicast, IC: InboundContext,

fn delay_to_retransmit(&self, retransmits_sent: u32) -> Option<Duration>

Calculates the duration of the delay to wait before sending the next retransmission.

fn delay_to_restart(&self) -> Option<Duration>

The delay to wait between when we have received a successful response and when we should send out another request.

fn max_rtt(&self) -> Duration

The maximum time to wait for an asynchronous response after having received an ACK.

fn transmit_wait_duration(&self) -> Duration

the maximum time from the first transmission of a Confirmable message to the time when the sender gives up on receiving an acknowledgement or reset.

fn write_payload( &self, msg: &mut dyn MessageWrite, socket_addr: &IC::SocketAddr, ) -> Result<(), Error>

Generates the outbound message by making calls into msg.

fn write_options( &self, msg: &mut dyn OptionInsert, socket_addr: &IC::SocketAddr, start: Bound<OptionNumber>, end: Bound<OptionNumber>, ) -> Result<(), Error>

Defines which options are going to be included in the outbound message.

fn supports_option(&self, option: OptionNumber) -> bool

Experimental: Used for determining if the given option seen in the reply message is supported or not.

fn handler( &mut self, context: Result<&IC, Error>, ) -> Result<ResponseStatus<OwnedImmutableMessage>, Error>

Handles the response to the outbound message.

fn trans_params(&self) -> Option<TP>

Experimental: Gets custom transmission parameters.

impl Eq for OwnedImmutableMessage

impl StructuralPartialEq for OwnedImmutableMessage