Trait Message

Source

pub trait Message: Sized {
    const ID: u32;
    const NAME: &'static str;
    const CRC_EXTRA: u8;
    const WIRE_LEN: usize;
    const BASE_FIELDS: &'static [(&'static str, &'static str, u8)];
    const DESCRIPTOR: &'static MessageDescriptor<'static>;

    // Required methods
    fn encode(&self, out: &mut [u8]) -> usize;
    fn decode(payload: &[u8]) -> Result<Self>;
}

Expand description

A typed MAVLink message: its identity on the wire and how it serializes.

Implemented for every message this crate types, via the message! declaration macro.

Required Associated Constants§

Source

const ID: u32

The message id on the wire.

Source

const NAME: &'static str

The message name, such as "HEARTBEAT", as used to derive CRC_EXTRA.

Source

const CRC_EXTRA: u8

The CRC_EXTRA seed folded into the checksum of a frame carrying this message.

Source

const WIRE_LEN: usize

The full length, in bytes, of this message’s base fields on the wire.

Source

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

The base fields in wire order as (type, name, array_len), the input from which CRC_EXTRA is derived and against which it is verified.

Source

const DESCRIPTOR: &'static MessageDescriptor<'static>

The message’s shape as data: the runtime counterpart of this type’s fields, for a caller reading and writing by name rather than through the struct.

Required Methods§

Source

fn encode(&self, out: &mut [u8]) -> usize

Serializes the message into out, returning the number of bytes written.

§Arguments

out - the destination buffer, which must be at least WIRE_LEN bytes; a MAX_PAYLOAD-byte buffer always suffices.

§Returns

The number of bytes written, which is WIRE_LEN.

Source

fn decode(payload: &[u8]) -> Result<Self>

Deserializes the message from a payload.

A short payload is zero-extended, as MAVLink 2 truncation requires, and a payload longer than WIRE_LEN (one carrying extension fields) has its trailing bytes ignored.

§Arguments

payload - the frame payload to read.

§Returns

The decoded message.

§Errors

Returns MavlinkError::BadPayload if the payload cannot form the message.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Message

Trait Message Copy item path

Required Associated Constants§

const ID: u32

const NAME: &'static str

const CRC_EXTRA: u8

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

Required Methods§

fn encode(&self, out: &mut [u8]) -> usize

§Arguments

§Returns

fn decode(payload: &[u8]) -> Result<Self>

§Arguments

§Returns

§Errors

Dyn Compatibility§

Implementors§

impl Message for Attitude

const ID: u32 = 30

const NAME: &'static str = "ATTITUDE"

const CRC_EXTRA: u8 = 39

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for AttitudeQuaternion

const ID: u32 = 31

const NAME: &'static str = "ATTITUDE_QUATERNION"

const CRC_EXTRA: u8 = 246

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for AutopilotVersion

const ID: u32 = 148

const NAME: &'static str = "AUTOPILOT_VERSION"

const CRC_EXTRA: u8 = 178

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for BatteryStatus

const ID: u32 = 147

const NAME: &'static str = "BATTERY_STATUS"

const CRC_EXTRA: u8 = 154

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for CommandAck

const ID: u32 = 77

const NAME: &'static str = "COMMAND_ACK"

const CRC_EXTRA: u8 = 143

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for CommandInt

const ID: u32 = 75

const NAME: &'static str = "COMMAND_INT"

const CRC_EXTRA: u8 = 158

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for CommandLong

const ID: u32 = 76

const NAME: &'static str = "COMMAND_LONG"

const CRC_EXTRA: u8 = 152

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for ExtendedSysState

const ID: u32 = 245

const NAME: &'static str = "EXTENDED_SYS_STATE"

const CRC_EXTRA: u8 = 130

const WIRE_LEN: usize

const BASE_FIELDS: &'static [(&'static str, &'static str, u8)]

const DESCRIPTOR: &'static MessageDescriptor<'static>

impl Message for GlobalPositionInt

const ID: u32 = 33

const NAME: &'static str = "GLOBAL_POSITION_INT"

const CRC_EXTRA: u8 = 104

const WIRE_LEN: usize

Trait Message