Struct mavio::protocol::Payload

source ·

pub struct Payload { /* private fields */ }

Expand description

^mavspec 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.

source

Payload size in bytes.

Note that for MAVLink 2 payloads trailing zero bytes are truncated.

See Payload::bytes.

source

pub fn upgrade(&mut self)

Upgrade payload to MAVLink 2 protocol version in-place.

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

To replace an existing payload by value, use Payload::upgraded.

source

pub fn upgraded(self) -> Payload

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 copy 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 §

The type returned in the event of a conversion error.

source §

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

§

type Owned = T

Struct mavio::protocol::Payload

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 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 AirlinkAuthResponse

type Error = SpecError

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

impl TryFrom<&Payload> for AirlinkEyeGsHolePushRequest

type Error = SpecError

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

impl TryFrom<&Payload> for AirlinkEyeGsHolePushResponse

type Error = SpecError

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

impl TryFrom<&Payload> for AirlinkEyeHp

type Error = SpecError

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

impl TryFrom<&Payload> for AirlinkEyeTurnInit

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

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

type Error = SpecError

impl TryFrom<&Payload> for Altitude

type Error = SpecError

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

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,