Struct DynamicDialect 

pub struct DynamicDialect { /* private fields */ }

Available on crate feature dialect-dynamic only.

An immutable MAVLink dialect loaded from XML at runtime.

Implementations

impl DynamicDialect

pub fn from_xml_file( path: impl AsRef<Path>, ) -> Result<Self, DynamicDialectError>

Load a dialect XML file and all of its relative <include> definitions.

The XML is parsed once. The resulting dialect is immutable, cheap to clone, and can be shared safely between readers.

pub fn message_definition( &self, message_id: u32, ) -> Option<&DynamicMessageDefinition>

Return the loaded definition for message_id.

pub fn message_definitions( &self, ) -> impl Iterator<Item = &DynamicMessageDefinition>

Return all loaded message definitions, ordered by message ID.

pub fn message_from_payload( &self, version: MavlinkVersion, message_id: u32, payload: impl Into<Vec<u8>>, ) -> Result<DynamicMessage, ParserError>

Construct an encodable runtime message from a known definition and its wire payload. This is the dynamic counterpart to constructing a generated MavMessage value before calling send.

pub fn message_from_fields<K>( &self, version: MavlinkVersion, message_name: &str, fields: impl IntoIterator<Item = (K, DynamicValue)>, ) -> Result<DynamicMessage, DynamicMessageError>

where K: AsRef<str>,

Construct a runtime message from its name and named field values.

Numeric values must match the field’s primitive type.

Trait Implementations

impl Clone for DynamicDialect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicDialect

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

Formats the value using the given formatter.

impl Dialect for DynamicDialect

type Message = DynamicMessage

The representation returned when a message is decoded.

type EncodeError = EncoderError

Error returned when encoding a message.

fn message_id(&self, message: &Self::Message) -> u32

MAVLink message ID for an encoded message.

fn extra_crc(&self, message_id: u32) -> Option<u8>

Return the CRC extra byte for message_id, if the message is known.

fn decode( &self, version: MavlinkVersion, message_id: u32, payload: &[u8], ) -> Result<Self::Message, ParserError>

Decode a validated MAVLink payload.

fn encode( &self, version: MavlinkVersion, message: &Self::Message, payload: &mut [u8], ) -> Result<usize, Self::EncodeError>

Serialize a dialect message payload for the selected MAVLink version.