Struct CoapResponse

pub struct CoapResponse { /* private fields */ }

Implementations

impl CoapResponse

pub fn new( type_: CoapMessageType, code: CoapResponseCode, ) -> Result<CoapResponse, MessageTypeError>

Creates a new CoAP response with the given message type and code.

Returns an error if the given message type is not allowed for CoAP responses (the allowed message types are CoapMessageType::Con and CoapMessageType::Non and CoapMessageType::Ack).

pub fn max_age(&self) -> Option<MaxAge>

Returns the “Max-Age” option value for this response.

pub fn set_max_age(&mut self, max_age: Option<MaxAge>)

Sets the “Max-Age” option value for this response.

This option indicates the maximum time a response may be cached (in seconds).

See RFC 7252, Section 5.10.5 for more information.

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

Returns the “Content-Format” option value for this request.

pub fn set_content_format(&mut self, content_format: Option<ContentFormat>)

Sets the “Content-Format” option value for this response.

This option indicates the content format of the body of this message.

See RFC 7252, Section 5.10.3 for more information.

pub fn etag(&self) -> Option<&ETag>

Returns the “ETag” option value for this request.

pub fn set_etag(&mut self, etag: Option<ETag>)

Sets the “ETag” option value for this response.

This option can be used by clients to request a specific representation of the requested resource.

The server may send an ETag value alongside a response, which the client can then set here to request the given representation.

See RFC 7252, Section 5.10.6 for more information.

pub fn echo(&self) -> Option<&Echo>

Returns the “Echo” option value for this request.

pub fn set_echo(&mut self, echo: Option<Echo>)

Sets the “Echo” option value for this response.

This option can be used by servers to ensure that a request is recent.

The client should include the provided option value in its next request.

As handling echo options on the client side is done automatically by libcoap, this option is not accessible in [CoapRequest], see man coap_send for more information.

See RFC 9175, Section 2.2 for more information.

pub fn observe(&self) -> Option<Observe>

Returns the “Observe” option value for this request.

pub fn set_observe(&mut self, observe: Option<Observe>)

Sets the “Observe” option value for this response.

This option indicates that this response is a notification for a previously requested resource observation.

This option is defined in RFC 7641 and is not part of the main CoAP spec. Some peers may therefore not support this option.

pub fn location(&self) -> Option<&CoapUri>

Returns the “Location” option value for this request.

pub fn set_location<U: Into<CoapUri>>( &mut self, uri: Option<U>, ) -> Result<(), OptionValueError>

Sets the “Location-Path” and “Location-Query” option values for this response.

These options indicate a relative URI for a resource created in response of a POST or PUT request.

The supplied URI must be relative to the requested path and must therefore also not contain a scheme, host or port. Also, each path component must be smaller than 255 characters.

If an invalid URI is provided, an OptionValueError is returned

See RFC 7252, Section 5.10.7 for more information.

pub fn into_message(self) -> CoapMessage

Converts this request into a CoapMessage that can be sent over a CoapSession.

pub fn from_message( pdu: CoapMessage, ) -> Result<CoapResponse, MessageConversionError>

Parses the given CoapMessage into a CoapResponse.

Returns a MessageConversionError if the provided PDU cannot be parsed into a response.

Trait Implementations

impl Clone for CoapResponse

fn clone(&self) -> CoapResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CoapMessageCommon for CoapResponse

fn set_code<C: Into<CoapMessageCode>>(&mut self, code: C)

Sets the message code of this response.

Panics

Panics if the provided message code is not a response code.

fn as_message(&self) -> &CoapMessage

Returns a reference to this message.

fn as_message_mut(&mut self) -> &mut CoapMessage

Returns a mutable reference to this message.

fn add_option(&mut self, option: CoapOption)

Add the supplied CoAP option to this message.

fn clear_options(&mut self)

Clear the list of options that were added to this message using add_option().

fn options_iter(&self) -> Iter<'_, CoapOption>

Returns an iterator over the options contained in this message.

fn type_(&self) -> CoapMessageType

Returns the CoAP message type (confirmable, non-confirmable, acknowledgement, rst) of this message.

fn set_type_(&mut self, type_: CoapMessageType)

Sets the CoAP message type (confirmable, non-confirmable, acknowledgement, rst) of this message.

fn code(&self) -> CoapMessageCode

Returns the message code of this message. To determine whether the message is a request or response, use CoapMessageCode::try_from() and match for the enum variants.

fn mid(&self) -> Option<CoapMessageId>

Returns the CoAP message ID for this message.

fn set_mid(&mut self, mid: Option<CoapMessageId>)

Sets the CoAP message ID for this message.

fn data(&self) -> Option<&[u8]>

Returns a reference to the data/body of this message.

fn set_data<D: Into<Box<[u8]>>>(&mut self, data: Option<D>)

Sets the data/body of this message.

fn token(&self) -> Option<&[u8]>

Returns the message token.

fn set_token<D: Into<Box<[u8]>>>(&mut self, token: Option<D>)

Sets the message token.

impl Debug for CoapResponse

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

Formats the value using the given formatter.

impl From<CoapResponse> for CoapMessage

fn from(val: CoapResponse) -> Self

Converts to this type from the input type.

impl PartialEq for CoapResponse

fn eq(&self, other: &CoapResponse) -> 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 Eq for CoapResponse

impl StructuralPartialEq for CoapResponse