Struct OwnedMessageDescriptor 

pub struct OwnedMessageDescriptor { /* private fields */ }

A message shape a caller owns, for a message from a dialect this crate does not type.

Examples

use pamoja_mavlink::dialect::{DynamicMessage, FieldType, MessageDescriptorBuilder};

// A private message, written the way its definition reads: declaration order, with
// the builder putting the fields on the wire largest first.
let shape = MessageDescriptorBuilder::new(50_000, "BATTERY_CELLS")
    .field("cell_mv", FieldType::U16, 6)
    .field("pack_id", FieldType::U8, 0)
    .field("uptime_ms", FieldType::U32, 0)
    .build()?;

shape.with_descriptor(|shape| -> Result<(), pamoja_mavlink::MavlinkError> {
    // The 32-bit field leads, then the array, then the byte.
    assert_eq!(shape.offset_of("uptime_ms"), Some(0));
    assert_eq!(shape.offset_of("cell_mv"), Some(4));
    assert_eq!(shape.wire_len(), 17);

    let mut message = DynamicMessage::new(shape)?;
    message.set_uint("cell_mv", 3, 4_150)?;
    assert_eq!(message.get_uint("cell_mv", 3)?, 4_150);
    Ok(())
})?;

Implementations

impl OwnedMessageDescriptor

pub fn from_descriptor(descriptor: &MessageDescriptor<'_>) -> Self

Takes an owned copy of a borrowed shape.

Arguments

• descriptor - the shape to copy, such as one from the built-in registry.

Returns

The owned shape.

pub fn id(&self) -> u32

Returns the message id.

Returns

The id on the wire.

pub fn name(&self) -> &str

Returns the message name.

Returns

The name, such as "BATTERY_CELLS".

pub fn crc_extra(&self) -> u8

Returns the CRC_EXTRA seed this shape implies.

Returns

The seed, which a frame carrying this message folds into its checksum.

pub fn fields(&self) -> &[OwnedFieldDescriptor]

Returns the fields in wire order.

Returns

The base fields largest first, then any extensions.

pub fn with_descriptor<R>( &self, query: impl FnOnce(&MessageDescriptor<'_>) -> R, ) -> R

Lends a borrowed view of this shape for the duration of a call.

A MessageDescriptor borrows a slice of fields that does not exist until it is assembled, so the view is built for the call rather than stored, which keeps this type free of self-references.

Arguments

• query - what to do with the borrowed shape.

Returns

Whatever query returns.

Trait Implementations

impl Clone for OwnedMessageDescriptor

fn clone(&self) -> OwnedMessageDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedMessageDescriptor

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

Formats the value using the given formatter.

impl Eq for OwnedMessageDescriptor

impl PartialEq for OwnedMessageDescriptor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for OwnedMessageDescriptor