Struct EncodedMessageView

pub struct EncodedMessageView<EM: EncodedMessage> { /* private fields */ }

A wrapper around any data structure containing a readable message

This is not Sync – while it is currently a zero-sized wrapper, it may gain optimizations later such as memoizing where the payload begins (and this is only practical with interior mutability).

See Message for how this does not perform early validation and handles message errors.

Implementations

impl<EM: EncodedMessage> EncodedMessageView<EM>

pub fn new(inner: EM) -> Self

Trait Implementations

impl<EM: EncodedMessage> AsRef<EM> for EncodedMessageView<EM>

When the inner item stores more than just the code and encoded options, this can be used to gain read-only access to any additional data. (Mutating access is blocked to ensure that future optimizations like memoizing the payload position are possible; it might still be enabled if memoized data is cleared just to be on the safe side).

fn as_ref(&self) -> &EM

Converts this type into a shared reference of the (usually inferred) input type.

impl<EM: Clone + EncodedMessage> Clone for EncodedMessageView<EM>

fn clone(&self) -> EncodedMessageView<EM>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<EM: Debug + EncodedMessage> Debug for EncodedMessageView<EM>

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

Formats the value using the given formatter.

impl<EM> Format for EncodedMessageView<EM>

where EM: Format + EncodedMessage, PhantomData<Cell<()>>: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<EM: EncodedMessage> ReadableMessage for EncodedMessageView<EM>

type Code = u8

See Self::code()

type MessageOption<'a> = MessageOption<'a> where Self: 'a

Type of an individual option, indiciating its option number and value

type OptionsIter<'a> = OptionsIter<'a> where Self: 'a

See Self::options()

fn code(&self) -> u8

Get the code (request method or response code) of the message

fn payload(&self) -> &[u8]

Get the payload set in the message

fn options(&self) -> OptionsIter<'_>

Produce all options in arbitrary order as an iterator

fn with_static_type_annotation(&self) -> Option<RefWithStaticType<'_, Self>>

Type ID of Self or a ’static version of Self