Struct OwnedDialect 

pub struct OwnedDialect { /* private fields */ }

A dialect a caller owns: message shapes looked up by id or name.

This is what makes a whole dialect usable rather than one message at a time. It also resolves the CRC_EXTRA a Parser needs, so frames from a private dialect check like any other.

Examples

use pamoja_mavlink::dialect::{FieldType, MessageDescriptorBuilder, OwnedDialect};
use pamoja_mavlink::{Header, Parser};

let mut dialect = OwnedDialect::new();
dialect.insert(
    MessageDescriptorBuilder::new(50_000, "BATTERY_CELLS")
        .field("pack_id", FieldType::U8, 0)
        .field("uptime_ms", FieldType::U32, 0)
        .build()?,
);

let shape = dialect.by_name("BATTERY_CELLS").expect("just inserted");
let frame = shape.with_descriptor(|shape| {
    let mut message = pamoja_mavlink::dialect::DynamicMessage::new(shape)?;
    message.set_uint("pack_id", 0, 2)?;
    message.to_frame(Header::new(9, 1, 0))
})?;

// A parser resolves the seed through the dialect, so the private frame verifies.
let resolve = |id| dialect.crc_extra(id);
let mut parser = Parser::new();
let received = frame
    .as_bytes()
    .iter()
    .filter_map(|byte| parser.push_byte(*byte, &resolve))
    .next()
    .expect("a whole frame");
assert_eq!(received.message_id(), 50_000);

Implementations

impl OwnedDialect

pub fn new() -> Self

Creates a dialect with no messages.

Returns

The empty dialect.

pub fn insert(&mut self, descriptor: OwnedMessageDescriptor)

Adds a message shape, replacing any shape already held for its id.

Arguments

• descriptor - the shape to add.

pub fn get(&self, msgid: u32) -> Option<&OwnedMessageDescriptor>

Looks a message shape up by id.

Arguments

• msgid - the message id.

Returns

The shape, or None if this dialect does not describe that id.

pub fn by_name(&self, name: &str) -> Option<&OwnedMessageDescriptor>

Looks a message shape up by name.

Arguments

• name - the message name.

Returns

The shape, or None if this dialect does not describe that name.

pub fn crc_extra(&self, msgid: u32) -> Option<u8>

Returns the CRC_EXTRA for a message id, falling back to the common dialect.

Arguments

• msgid - the message id.

Returns

The seed, or None if neither this dialect nor the common one knows the id.

pub fn len(&self) -> usize

Returns how many message shapes this dialect holds.

Returns

The count.

pub fn is_empty(&self) -> bool

Reports whether this dialect holds no message shapes.

Returns

true if it is empty.

Trait Implementations

impl Clone for OwnedDialect

fn clone(&self) -> OwnedDialect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedDialect

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

Formats the value using the given formatter.

impl Default for OwnedDialect

fn default() -> OwnedDialect

Returns the “default value” for a type.