Struct kwap_msg::Opt

pub struct Opt<C: Collection<u8>> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>,  {
    pub delta: OptDelta,
    pub value: OptValue<C>,
}

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.

Related

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

Fields

delta: OptDelta

See OptDelta

value: OptValue<C>

See OptValue

Implementations

impl<C: Collection<u8>> Opt<C> where
    for<'b> &'b C: IntoIterator<Item = &'b u8>, 

pub fn extend_bytes(self, bytes: &mut impl Extend<u8>)

Given a collection to Extend and an Opt, add that Opt’s bytes to the collection.

Trait Implementations

impl<C: Clone + Collection<u8>> Clone for Opt<C> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>, 

fn clone(&self) -> Opt<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Collection<u8>> Debug for Opt<C> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>, 

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

Formats the value using the given formatter.

impl<C: Default + Collection<u8>> Default for Opt<C> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>, 

fn default() -> Opt<C>

Returns the “default value” for a type.

impl<'a, C: Collection<u8>, I: Iterator<Item = &'a Opt<C>>> EnumerateOptNumbers<&'a Opt<C>> for I where
    for<'b> &'b C: IntoIterator<Item = &'b u8>, 

fn enumerate_option_numbers(self) -> EnumerateOptNumbersIter<&'a Opt<C>, Self>

Creates an iterator which gives the current Opt along with its Number.

impl<C: Collection<u8>, I: Iterator<Item = Opt<C>>> EnumerateOptNumbers<Opt<C>> for I where
    for<'a> &'a C: IntoIterator<Item = &'a u8>, 

fn enumerate_option_numbers(self) -> EnumerateOptNumbersIter<Opt<C>, Self>

Creates an iterator which gives the current Opt along with its Number.

impl<C: Collection<u8>> GetSize for Opt<C> where
    for<'b> &'b C: IntoIterator<Item = &'b u8>, 

fn get_size(&self) -> usize

Get the runtime size (in bytes) of a struct

fn max_size(&self) -> Option<usize>

Get the max size that this data structure can acommodate.

fn size_is_zero(&self) -> bool

Check if the runtime size is zero

fn is_full(&self) -> bool

Is there no room left in this collection?

impl<C: PartialEq + Collection<u8>> PartialEq<Opt<C>> for Opt<C> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>, 

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

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

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

This method tests for !=.

impl<C: PartialOrd + Collection<u8>> PartialOrd<Opt<C>> for Opt<C> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>, 

fn partial_cmp(&self, other: &Opt<C>) -> 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<C: Collection<u8>> StructuralPartialEq for Opt<C> where
    for<'a> &'a C: IntoIterator<Item = &'a u8>,