Struct Message

pub struct Message { /* private fields */ }

MAVLink message

Implementations

impl Message

pub fn builder() -> MessageBuilder

Initiates builder.

Instead of constructor we use builder pattern. An instance of MessageBuilder returned by this function is initialized with default values. Once desired values are set, you can call MessageBuilder::build to obtain Message.

Examples

use mavinspect::protocol::Message;
use mavinspect::utils::Builder;

let message = Message::builder()
    .set_name("name".to_string())
    .set_description("description")
    .build();

assert!(matches!(message, Message { .. }));
assert_eq!(message.name(), "name");
assert_eq!(message.description(), "description");

pub fn id(&self) -> MessageId

Unique message ID within dialect.

pub fn name(&self) -> &str

Message name

pub fn description(&self) -> &str

Message description.

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

List of message fields.

pub fn get_field_by_name(&self, name: impl AsRef<str>) -> Option<&MessageField>

Returns message field specified by its name if exists.

pub fn wip(&self) -> bool

Work in progress status.

pub fn deprecated(&self) -> Option<&Deprecated>

Deprecation status.

pub fn defined_in(&self) -> &str

Dialect canonical name where this message was finally defined.

We track dialect in which message was defined to help to optimise code generation.

The comprehensive list of dialects where this message was defined can be obtained in Self::appears_in.

Use Self::was_defined_in to check whether message was defined in a specific dialect.

pub fn appears_in(&self) -> &[impl AsRef<str>]

Returns the list of dialect canonical names where this message was defined.

The dialect where the message finally belongs to can be obtained in Self::defined_in.

Use Self::was_defined_in to check whether message was defined in a specific dialect.

pub fn was_defined_in(&self, dialect_canonical_name: impl AsRef<str>) -> bool

Returns true if this message was defined in a dialect with a specified canonical name.

See also: Self::defined_in and Self::appears_in.

pub fn size_v2(&self) -> usize

Size of the fields payload according to MAVLink 2 protocol version.

Examples

use mavinspect::protocol::{MavType, Message, MessageField};
use mavinspect::utils::Builder;

let msg = Message::builder()
    .set_fields(vec![
        MessageField::builder()
            .set_type(MavType::Array(Box::new(MavType::Float), 3))  // Must be 12
            .build(),
        MessageField::builder()
            .set_type(MavType::Array(Box::new(MavType::UInt8), 5))  // Must be 5
            .build(),
        MessageField::builder()
            .set_type(MavType::Float)                               // Must be 4
            .build(),
    ])
    .build();

assert_eq!(msg.size_v2(), 21);

pub fn size_v1(&self) -> usize

Size of the fields payload according to MAVLink 2 protocol version.

Examples

use mavinspect::protocol::{MavType, Message, MessageField};
use mavinspect::utils::Builder;

let msg = Message::builder()
    .set_fields(vec![
        MessageField::builder()
            .set_type(MavType::Array(Box::new(MavType::Float), 3))  // Must be 12
            .build(),
        MessageField::builder()
            .set_type(MavType::Array(Box::new(MavType::UInt8), 5))  // Must be 5
            .build(),
        MessageField::builder()
            .set_type(MavType::Float)                               // Ignored
            .set_extension(true)
            .build(),
    ])
    .build();

assert_eq!(msg.size_v1(), 17);

pub fn extension_fields_idx(&self) -> Option<usize>

Returns index of the first extension field if any.

See:

• MAVLink fields reordering.
• MAVLink extension fields.
• MessageField::extension.

pub fn has_extension_fields(&self) -> bool

Returns whether this message has extension fields.

See:

• MAVLink fields reordering.
• MAVLink extension fields.
• MessageField::extension.

pub fn fields_v1(&self) -> Vec<&MessageField>

Returns fields applicable to MavLink 1 protocol version.

Basically, as required by specification, all extension fields are excluded.

See: MAVLink message extensions.

pub fn fields_v2(&self) -> Vec<&MessageField>

Returns fields applicable to MAVLink 2 protocol version.

All extension fields will be included.

Fields are reordered according to MAVLink specification

pub fn reordered_fields(&self) -> Vec<&MessageField>

Returns reordered fields according to MAVLink specification.

pub fn base_fields(&self) -> Vec<&MessageField>

Returns base fields.

Base fields are the fields which are not marked as extensions.

These fields are not reordered. To get reordered base fields use Message::fields_v1.

See: MAVLink message extensions.

pub fn base_fields_reordered(&self) -> Vec<&MessageField>

Returns base fields reordered according to MAVLink specification.

Base fields are the fields which are not marked as extensions.

See:

• MAVLink fields reordering.
• MAVLink message extensions.

pub fn extension_fields(&self) -> Vec<&MessageField>

Returns extension fields.

See: MAVLink message extensions.

pub fn is_v1_compatible(&self) -> bool

Whether this message is compatible with MAVLink 1.

See: MAVLink versions.

pub fn crc_extra(&self) -> u8

Message CRC_EXTRA calculated from message XML definition.

Calculates CRC for message name and key message fields to detect incompatible changes in message definition.

See: CRC_EXTRA calculation in MAVLink docs.

pub fn fingerprint(&self) -> Fingerprint

Calculates message fingerprint.

A value of opaque type Fingerprint that contains message CRC.

Fingerprint is similar to Self::crc_extra but takes into consideration all fields and all message metadata.

This function calculates a relaxed version of a fingerprint, use Self::fingerprint_strict to take into account MAVLink enums within a dialect.

pub fn fingerprint_strict(&self, dialect: Option<&Dialect>) -> Fingerprint

Calculates message fingerprint.

A value of opaque type Fingerprint that contains dialect CRC.

Fingerprint is similar to Self::crc_extra but takes into consideration all fields and all message metadata.

Calculates a strict version of fingerprint if dialect provided. Use Self::fingerprint to calculate a relaxed fingerprint.

Trait Implementations

impl Buildable for Message

fn to_builder(&self) -> MessageBuilder

Creates MessageBuilder initialised with current message.

Examples

use mavinspect::protocol::Message;
use mavinspect::utils::{Buildable, Builder};

let original = Message::builder()
    .set_name("original")
    .set_description("original")
    .build();

let updated = original.to_builder()
    .set_description("updated")
    .build();

assert_eq!(updated.name(), "original");
assert_eq!(updated.description(), "updated");

type Builder = MessageBuilder

Builder for this entity.

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedType for Message

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.

impl Serialize for Message

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for Message

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl Flatten for Message