Struct mavinspect::protocol::Dialect

pub struct Dialect { /* private fields */ }

MAVLink dialect specification.

Implementations

impl Dialect

pub fn new( name: impl AsRef<str>, version: Option<DialectVersion>, dialect: Option<DialectId>, messages: Vec<Message>, enums: Vec<Enum> ) -> Self

Default constructor

Arguments

• name dialect name.
• version dialect version (if provided).
• dialect dialect ID.
• messages dialect messages.
• enums dialect enums.

pub fn name(&self) -> &str

Dialect name.

See Self::canonical_name for canonical name used as a key in Protocol::dialects.

pub fn canonical_name(&self) -> &str

Canonical dialect name.

As a dialect name we use a file base name of its XML definition (without extension). However, upon XML parsing loading, we convert this name into canonical form (using dialect_canonical_name). Canonical names are used during dialect discovery by Inspector and in InspectorBuilder::set_include/InspectorBuilder::set_exclude. We do this in order to avoid naming collisions when someone tries to generate source code based on dialect names.

pub fn version(&self) -> Option<DialectVersion>

Dialect version.

pub fn dialect(&self) -> Option<DialectId>

Dialect ID.

pub fn messages(&self) -> impl IntoIterator<Item = &Message> + Clone

Collection of dialect messages.

pub fn enums(&self) -> impl IntoIterator<Item = &Enum> + Clone

Collection of dialect enums.

pub fn commands(&self) -> impl IntoIterator<Item = &Command> + Clone

Collection of dialect commands.

pub fn contains_message_with_name(&self, name: &str) -> bool

Check that message with specified name is present in dialect.

pub fn contains_enum_with_name(&self, name: &str) -> bool

Check that enum with specified name is present in dialect.

pub fn contains_command_with_name(&self, name: &str) -> bool

Check that command with specified name is present in dialect.

pub fn get_message_by_name(&self, name: &str) -> Option<&Message>

Get message with specified name.

pub fn get_enum_by_name(&self, name: &str) -> Option<&Enum>

Get enum with specified name.

pub fn get_command_by_name(&self, name: &str) -> Option<&Command>

Get command with specified name.

pub fn contains_message_with_id(&self, id: MessageId) -> bool

Check that message with specified id is present in dialect.

pub fn get_message_by_id(&self, id: MessageId) -> Option<&Message>

Get message with specified id.

pub fn microservices(&self) -> Microservices

MAVLink microservices supported by dialect.

pub fn filtered(&self, filter: &Filter) -> Self

Creates a new instance of Dialect with entities matching Filter.

Use Dialect::retain to filter an existing instance instead.

pub fn retain(&mut self, filter: &Filter)

Retain only entities matching provided Filter.

This is an in-place version on Dialect::filtered. The latter create a new filtered instance.

pub fn fingerprint(&self) -> u64

Dialect fingerprint.

A 64-bit value that contains dialect CRC.

Trait Implementations

impl Clone for Dialect

fn clone(&self) -> Dialect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dialect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dialect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Dialect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.