Struct libcoap_rs::message::request::CoapRequest

pub struct CoapRequest { /* private fields */ }

Representation of a CoAP request message.

This struct wraps around the more direct CoapMessage and allows easier definition of typical options used in requests.

Implementations

impl CoapRequest

pub fn new(
    type_: CoapMessageType,
    code: CoapRequestCode
) -> Result<CoapRequest, MessageTypeError>

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

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

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

Returns the “Accept” option value for this request.

pub fn set_accept(&mut self, accept: Option<ContentFormat>)

Sets the “Accept” option value for this request.

This option indicates the acceptable content formats for the response.

See RFC 7252, Section 5.10.4 for more information.

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

Returns the “ETag” option value for this request.

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

Sets the “ETag” option value for this request.

This option can be used 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 if_match(&self) -> Option<&Vec<CoapMatch>>

Returns the “If-Match” option value for this request.

pub fn set_if_match(&mut self, if_match: Option<Vec<CoapMatch>>)

Sets the “If-Match” option value for this request.

This option indicates a match expression that must be fulfilled in order to perform the request.

See RFC 7252, Section 5.10.8.1 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 request.

This option indicates the content format of the body of this message. It is not to be confused with the “Accept” option, which indicates the format that the body of the response to this message should have.

See RFC 7252, Section 5.10.3 for more information.

pub fn if_none_match(&self) -> bool

Returns the “If-None-Match” option value of this request.

pub fn set_if_none_match(&mut self, if_none_match: bool)

Sets the “If-None-Match” option value for this request.

This option indicates that no match expression may be fulfilled in order for this request to be fulfilled.

It is usually nonsensical to set this value to true if an If-Match-Expression has been set.

See RFC 7252, Section 5.10.8.2 for more information.

pub fn hop_limit(&self) -> Option<HopLimit>

Returns the “Hop-Limit” option value of this request.

pub fn set_hop_limit(&mut self, hop_limit: Option<HopLimit>)

Sets the “Hop-Limit” option value for this request.

This option is mainly used to prevent proxying loops and specifies the maximum number of proxies that the request may pass.

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

pub fn no_response(&self) -> Option<NoResponse>

Returns the “No-Response” option value for this request.

pub fn set_no_response(&mut self, no_response: Option<NoResponse>)

Sets the “No-Response” option value for this request.

This option indicates that the client performing this request does not wish to receive a response for this request.

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

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 request.

This option indicates that the client performing this request wishes to be notified of changes to the requested resource.

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 uri(&self) -> Option<&CoapUri>

Returns the CoAP URI that is requested (either a normal request URI or a proxy URI)

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

Sets the URI requested in this request.

The request URI must not have a scheme defined, and path segments, query segments and the host itself each have to be smaller than 255 characters.

If the URI has an invalid format, an OptionValueError is returned.

This method overrides any previously set proxy URI.

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

Sets the proxy URI requested in this request.

The proxy URI must be an absolute URL with a schema valid for CoAP proxying (CoAP(s) or HTTP(s)), The proxy URI must not be longer than 1023 characters.

If the URI has an invalid format, an OptionValueError is returned.

This method overrides any previously set request URI.

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

Parses the given CoapMessage into a CoapRequest.

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

pub fn into_message(self) -> CoapMessage

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

Trait Implementations

impl Clone for CoapRequest

fn clone(&self) -> CoapRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CoapMessageCommon for CoapRequest

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

Sets the message code of this request.

Panics

Panics if the provided message code is not a request 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 CoapRequest

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

Formats the value using the given formatter.

impl From<CoapRequest> for CoapMessage

fn from(val: CoapRequest) -> Self

Converts to this type from the input type.

impl Hash for CoapRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<CoapRequest> for CoapRequest

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CoapRequest

impl StructuralEq for CoapRequest

impl StructuralPartialEq for CoapRequest