Struct CommandCancel

pub struct CommandCancel {
    pub target_system: u8,
    pub target_component: u8,
    pub command: MavCmd,
}

MAVLink COMMAND_CANCEL message.

The minimum supported MAVLink version is MAVLink 1.

Description

Cancel a long running command. The target system should respond with a COMMAND_ACK to the original command with result=MAV_RESULT_CANCELLED if the long running process was cancelled. If it has already completed, the cancel action can be ignored. The cancel action can be retried until some sort of acknowledgement to the original command has been received. The command microservice is documented at https://mavlink.io/en/services/command.html

Encoding/Decoding

Message encoding/decoding are provided by implementing core::convert::TryFrom<Payload> for CommandCancel (encoding) and [IntoPayload] (decoding) traits. These traits are implemented by Message proc macro.

Fields

target_system: u8

MAVLink field target_system.

System executing long running command. Should not be broadcast (0).

target_component: u8

MAVLink field target_component.

Component executing long running command.

command: MavCmd

MAVLink field command.

Command ID (of command to cancel).

Implementations

impl CommandCancel

pub const ID: u32 = 80u32

MavLink message ID.

pub const fn spec() -> MessageInfo

Returns specification for this message.

pub const fn message_id() -> u32

Message ID.

pub const fn crc_extra() -> u8

Message CRC_EXTRA.

pub const fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

Trait Implementations

impl Clone for CommandCancel

fn clone(&self) -> CommandCancel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandCancel

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

Formats the value using the given formatter.

impl Default for CommandCancel

fn default() -> CommandCancel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommandCancel

fn deserialize<__D>( __deserializer: __D, ) -> Result<CommandCancel, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CommandCancel> for ArmAuthMsrv

fn from(value: CommandCancel) -> ArmAuthMsrv

Converts to this type from the input type.

impl From<CommandCancel> for CommandCancel

fn from(value: CommandCancel) -> CommandCancel

Converts to this type from the input type.

impl IntoPayload for CommandCancel

fn encode(&self, version: MavLinkVersion) -> Result<Payload, SpecError>

Encodes message into MAVLink payload.

impl MessageSpec for CommandCancel

fn id(&self) -> u32

MAVLink message ID.

fn min_supported_mavlink_version(&self) -> MavLinkVersion

Minimum supported MAVLink protocol version.

fn crc_extra(&self) -> u8

Message EXTRA_CRC calculated from message XML definition.

impl MessageSpecStatic for CommandCancel

fn spec() -> MessageInfo

Returns specification for this message.

fn message_id() -> u32

Message ID.

fn crc_extra() -> u8

Message CRC_EXTRA.

fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

impl NamedType for CommandCancel

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 PartialEq for CommandCancel

fn eq(&self, other: &CommandCancel) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommandCancel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Payload> for CommandCancel

type Error = SpecError

The type returned in the event of a conversion error.

fn try_from( value: &Payload, ) -> Result<CommandCancel, <CommandCancel as TryFrom<&Payload>>::Error>

Performs the conversion.

impl TryFrom<CommandCancel> for CommandCancel

type Error = SpecError

The type returned in the event of a conversion error.

fn try_from( value: CommandCancel, ) -> Result<CommandCancel, <CommandCancel as TryFrom<CommandCancel>>::Error>

Performs the conversion.

impl Type for CommandCancel

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 CommandCancel

impl Message for CommandCancel

impl StructuralPartialEq for CommandCancel