Struct Payload

Source

pub struct Payload { /* private fields */ }

Expand description

MAVlink message payload.

Encapsulates MAVLink payload. In no_std non-allocating targets it uses fixed-sized arrays of bytes. Otherwise, payload is stored on heap as a dynamically sized sequence.

Implementations§

Source §

impl Payload

Source

pub fn new(id: u32, payload: &[u8], version: MavLinkVersion) -> Payload

Default constructor.

Upon creation, the length of the provided payload will define Payload::length the maximum length of the Payload::bytes.

If payload is longer, than PAYLOAD_MAX_SIZE, all trailing elements will be ignored.

For MavLink v2 the trailing zeros will be truncated according to specification.

Source

pub fn id(&self) -> u32

MAVLink message ID.

Source

pub fn bytes(&self) -> &[u8] ⓘ

Message payload as bytes.

For MAVLink 2 zero trailing bytes will be truncated. See MAVLink 2 payload truncation.

Source

pub fn bytes_mut(&mut self) -> &mut [u8] ⓘ

Message payload as mutable byte slice.

For MAVLink 2 zero trailing bytes will be truncated. See MAVLink 2 payload truncation.

Source

Upgrade protocol version to MAVLink 2 replacing payload by value.

The reverse procedure is not possible since MAVLink 2 payload may contain extra fields and its trailing zero bytes are truncated.

To upgrade payload in-place, use Payload::upgrade.

Trait Implementations§

Source §

impl Clone for Payload

Source §

fn clone(&self) -> Payload

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<'de> Deserialize<'de> for Payload

Source §

fn deserialize<D>( deserializer: D, ) -> Result<Payload, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl NamedType for Payload

Source §

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.

Source §

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.

Source §

Returns the definition of a type using the provided generics. Read more

Source §

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.

Source §

impl Flatten for Payload

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

Payload

Struct Payload Copy item path

Implementations§

impl Payload

pub fn new(id: u32, payload: &[u8], version: MavLinkVersion) -> Payload

pub fn id(&self) -> u32

pub fn bytes(&self) -> &[u8] ⓘ

pub fn bytes_mut(&mut self) -> &mut [u8] ⓘ

pub fn version(&self) -> MavLinkVersion

pub fn length(&self) -> u8

pub fn upgrade(&mut self)

pub fn upgraded(self) -> Payload

Trait Implementations§

impl Clone for Payload

fn clone(&self) -> Payload

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

impl Debug for Payload

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

impl Default for Payload

fn default() -> Payload

impl<'de> Deserialize<'de> for Payload

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

impl NamedType for Payload

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

impl Serialize for Payload

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

impl TryFrom<&Payload> for ActuatorControlTarget

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for ActuatorOutputStatus

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AdapTuning

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AdsbVehicle

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for Ahrs

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for Ahrs2

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for Ahrs3

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AirlinkAuth

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AirlinkAuth

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AirlinkAuth

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AirlinkAuth

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AirlinkAuthResponse

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for Airspeed

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AirspeedAutocal

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for Airspeeds

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for AisVessel

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for All

type Error = SpecError

fn try_from(value: &Payload) -> Result<Self, Self::Error>

impl TryFrom<&Payload> for Altitude

Struct Payload

fn deserialize<D>( deserializer: D, ) -> Result<Payload, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,