Struct mavspec::rust::gen::BuildHelper

pub struct BuildHelper { /* private fields */ }

Code builder for Rust generator.

Usage

use mavinspect::protocol::Microservices;
use mavspec::rust::gen::BuildHelper;

// Paths to XML definitions directories.
let sources = vec![
    "./message_definitions/standard",
    "./message_definitions/extra",
];
// Output path
let destination = "../tmp/mavlink";

// Generate rust bindings
BuildHelper::builder(destination)
    .set_sources(&sources)
    // Only include the following dialects
    .set_include_dialects(&["minimal", "common", "ardupilotmega"])
    // Explicitly exclude the following dialects
    .set_exclude_dialects(&["ardupilotmega"])
    // Include only entities from the following MAVLink microservices
    .set_microservices(&["HEARTBEAT", "COMMAND"])
    // Explicitly add messages
    .set_messages(&["PROTOCOL_VERSION"])
    .generate()
    .unwrap();

Implementations

impl BuildHelper

pub fn builder<T>(out_path: T) -> BuildHelperBuilder

where T: Into<PathBuf>,

Creates configuration builder for BuildHelper.

Takes out_path as argument. The output path for generated content.

pub fn generate(&self) -> Result<(), RustGenError>

Scans for dialects and generates MAVLink dialects.

pub fn out_path(&self) -> &Path

Output path for autogenerated files.

pub fn sources(&self) -> Option<Vec<&Path>>

List of directories with MAVLink XML definitions.

pub fn manifest_path(&self) -> Option<&Path>

Path to Cargo.toml from which meta information will be extracted.

You can specify configuration in your Cargo.toml file:

[package.metadata.mavspec]
microservices = ["HEARTBEAT", "MISSION", "COMMAND"]
messages = ["PROTOCOL_VERSION", "MAV_INSPECT_V1", "PING"]
enums = ["STORAGE_STATUS", "GIMBAL_*"]
commands = ["MAV_CMD_DO_CHANGE_SPEED", "MAV_CMD_DO_SET_ROI*"]
generate_tests = false

If Self::manifest_path is set, then the following parameters will be populated from keys in Cargo.toml:

• Self::microservices from microservices key.
• Self::messages from messages key.
• Self::enums from enums key.
• Self::commands from commands key.
• Self::generate_tests from generate_tests key.

Note that if set explicitly, these parameters has precedence over keys from manifest.

pub fn include_dialects(&self) -> Option<HashSet<&str>>

Included dialects.

pub fn exclude_dialects(&self) -> Option<HashSet<&str>>

Excluded dialects.

pub fn messages(&self) -> Option<Vec<&str>>

If set, then defines the list of MAVLink messages to generate.

If Self::microservices are set, then the messages will be included in addition to those defined by microservices specifications.

pub fn enums(&self) -> Option<Vec<&str>>

If set, then defines the list of MAVLink enums to generate.

If Self::microservices are set, then the enums will be included in addition to those defined by microservices specifications.

pub fn commands(&self) -> Option<Vec<&str>>

If set, then defines the list of MAVLink commands to generate.

If Self::microservices are set, then the commands will be included in addition to those defined by microservices specifications.

pub fn microservices(&self) -> Option<&Microservices>

If set, then defines MAVLink microservices to be generated.

All messages from Self::messages will be included regardless of microservices specifications.

pub fn protocol(&self) -> Option<&Protocol>

MAVLink protocol containing parsed dialects.

pub fn serde(&self) -> bool

Serde support flag for generated entities.

pub fn generate_tests(&self) -> bool

Tests generation flag.

If set to true, then tests will be generated.

Trait Implementations

impl Clone for BuildHelper

fn clone(&self) -> BuildHelper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildHelper

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

Formats the value using the given formatter.

impl Default for BuildHelper

fn default() -> BuildHelper

Returns the “default value” for a type.