Struct kwap_msg::alloc::Opt

pub struct Opt {
    pub delta: OptDelta,
    pub value: OptValue,
}

Low-level representation of a freshly parsed CoAP Option

Both requests and responses may include a list of one or more options. For example, the URI in a request is transported in several options, and metadata that would be carried in an HTTP header in HTTP is supplied as options as well.

Option Numbers

This struct just stores data parsed directly from the message on the wire, and does not compute or store the Option Number.

To get Option OptNumbers, you can use the iterator extension EnumerateOptNumbers on a collection of Opts.

alloc / no-alloc

When crate feature alloc is enabled, you can use crate::alloc::Opt, which uses heap allocation for data storage, or crate::no_alloc::Opt, which instead has a fixed capacity and uses stack allocation for data storage.

When alloc is disabled, you must use crate::no_alloc::Opt.

Related

• RFC7252#section-3.1 Option Format
• RFC7252#section-5.4 Options

Fields

delta: OptDelta

See OptDelta

value: OptValue

See OptValue

Trait Implementations

impl Clone for Opt

fn clone(&self) -> Opt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Opt

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

Formats the value using the given formatter.

impl From<Opt> for Vec<u8>

fn from(opt: Opt) -> Vec<u8>

Performs the conversion.

impl GetOptDelta for Opt

fn get_delta(&self) -> OptDelta

impl GetSize for Opt

fn get_size(&self) -> usize

impl PartialEq<Opt> for Opt

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

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

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

This method tests for !=.

impl PartialOrd<Opt> for Opt

fn partial_cmp(&self, other: &Opt) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Opt