coap-message-implementations 0.1.11

//! Tools for iterating over encoded messages
//!
//! [`OptPayloadReader`] is the main struct of this module.

use crate::option_extension::take_extension;

/// Item type for an [`OptPayloadReader`]
#[derive(Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum OptItem<'a> {
    Option { number: u16, data: &'a [u8] },
    Payload(&'a [u8]),
    Error(&'static str),
}

/// Iteration cursor over a CoAP message's options and payload
///
/// This iterates over a contiguious memory area that contains encoded CoAP options and possibly a
/// payload marker followed by a payload.
///
/// It will yield any number of ascending options, possibly followed by a payload, followed by the
/// end of iteration.
///
/// An iteration item containing an Error puts the object into an indeterminate state; continuing
/// iteration will produce nonsentical results.
//
// FIXME become non-pub once coapwsmessage figures out a better way to use InMemoryMessage
pub struct OptPayloadReader<'a> {
    slice: &'a [u8],
    option_base: u16,
}

impl<'a> OptPayloadReader<'a> {
    /// Initialize this iterator over the given slice of memory.
    ///
    /// The message is assumed to be the start of a CoAP message; thus, option numbers start at
    /// zero.
    #[must_use]
    pub fn new(slice: &'a [u8]) -> Self {
        Self {
            slice,
            option_base: 0,
        }
    }

    /// Re-construct this iterator over the given slice of memory.
    pub(crate) fn new_from(slice: &'a [u8], option_base: u16) -> Self {
        Self { slice, option_base }
    }

    /// Destruct into it's field components to get at `self.slice`.
    pub(crate) fn destruct(self) -> (&'a [u8], u16) {
        (self.slice, self.option_base)
    }
}

impl<'a> Iterator for OptPayloadReader<'a> {
    type Item = OptItem<'a>;

    fn next(&mut self) -> Option<OptItem<'a>> {
        let delta_len = *self.slice.first()?;
        self.slice = &self.slice[1..];

        if delta_len == 0xff {
            return Some(OptItem::Payload(core::mem::take(&mut self.slice)));
        }

        let mut delta = u16::from(delta_len) >> 4;
        let mut len = u16::from(delta_len) & 0x0f;

        if take_extension(&mut delta, &mut self.slice).is_err() {
            // FIXME here and following: Is there any ergonomics trick that allows returning
            // Some(...Error(...)) using the questionmark operator?
            return Some(OptItem::Error("Erroneous delta"));
        }
        if take_extension(&mut len, &mut self.slice).is_err() {
            return Some(OptItem::Error("Erroneous len"));
        }

        if let Some(s) = self.option_base.checked_add(delta) {
            self.option_base = s;
        } else {
            return Some(OptItem::Error("Options wrap"));
        }

        let len = len.into();

        if self.slice.len() < len {
            return Some(OptItem::Error("Too short for option"));
        }

        let (retslice, tail) = self.slice.split_at(len);
        self.slice = tail;

        Some(OptItem::Option {
            number: self.option_base,
            data: retslice,
        })
    }
}