Struct Command

pub struct Command { /* private fields */ }

MAVLink command.

Usage

Commands can be created only from the corresponding EnumEntry.

use mavinspect::protocol::{Command, EnumEntry, EnumEntryMavCmdParam};
use mavinspect::utils::{Buildable, Builder};

let cmd_entry = EnumEntry::builder()
    .set_name("CMD_CUSTOM")
    .set_params(vec![
        EnumEntryMavCmdParam::builder()
            .set_index(1)
            .set_description("first")
            .build(),
        /* create remaining parameters in the same fashion */
    ])
    .build();

let command = Command::from(cmd_entry);

assert_eq!(
    command.params().iter().map(|param| param.description()).collect::<Vec<_>>(),
    vec!["first", "second", "third", "fourth", "fifth", "sixth", "seventh"]
);

Implementations

impl Command

pub fn from_enum_entry(enum_entry: &EnumEntry) -> Self

Constructs Command from EnumEntry.

pub fn value(&self) -> MavCmdValue

Enum entry value.

pub fn name(&self) -> &str

Enum entry name.

pub fn name_stripped(&self) -> &str

Command name without the corresponding enum name prefix.

See EnumEntry::name_stripped for stripping logic details.

pub fn description(&self) -> &str

Enum entry description.

pub fn has_location(&self) -> bool

Has location.

See EnumEntryMavCmdFlags::has_location for details.

pub fn is_destination(&self) -> bool

Is destination.

See EnumEntryMavCmdFlags::is_destination for details.

pub fn mission_only(&self) -> bool

Mission only.

See EnumEntryMavCmdFlags::mission_only for details.

pub fn params(&self) -> &[EnumEntryMavCmdParam]

Enum entry MAV_CMD parameters.

pub fn wip(&self) -> bool

Work in progress status.

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

Deprecation status.

pub fn defined_in(&self) -> &str

Dialect name where this command was defined.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Default for Command

fn default() -> Command

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Command

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EnumEntry> for Command

fn from(value: EnumEntry) -> Self

Constructs Command from EnumEntry.

impl NamedType for Command

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 Command

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 Command

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 Command