1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
use crate::error::{ChecksumError, VersionError};
use crate::protocol::{
Checksum, CrcExtra, MessageId, Payload, PayloadLength, Sequence, Signature, SystemId,
};
use crate::prelude::*;
/// Version-agnostic MAVLink frame, that can be matched according to its protocol version.
///
/// [`MavFrame`] allows to work with MAVLink frames dynamically, but still type-safely, where
/// generic [`Frame`] is suboptimal. It has almost the same protocol-agnostic methods as [`Frame`],
/// to access protocol-specific functionality, you have to convert or pattern match [`MavFrame`]
/// back into a [`Frame`].
///
/// It is not possible to create [`MavFrame`] directly. An instance of [`Frame`] should be obtained
/// first.
///
/// # Examples
///
/// Create [`MavFrame`] from an instance of [`Frame`] and then turn back into a versionless frame:
///
/// ```rust
/// # use mavio::dialects::minimal::messages::Heartbeat;
/// use mavio::prelude::*;
///
/// let frame: Frame<_> = // ... obtain a frame
/// # Frame::builder().version(V2).sequence(1).system_id(1).component_id(1).message(&Heartbeat::default()).unwrap().build();
///
/// let mav_frame = MavFrame::new(frame);
///
/// match mav_frame {
/// MavFrame::V1(_) => { /* `MAVLink 1` specific logic */ }
/// MavFrame::V2(_) => { /* `MAVLink 2` specific logic */ }
/// }
///
/// let frame: Frame<Versionless> = mav_frame.into_versionless();
/// ```
///
/// Update existing instance of [`Frame`] with a protocol version compatible [`MavFrame`] (available
/// only when `unsafe` feature is enabled):
///
/// ```rust
/// # #[cfg(feature = "unsafe")] {
/// # use mavio::dialects::minimal::messages::Heartbeat;
/// use mavio::prelude::*;
///
/// let mut frame: Frame<_> = // ... obtain a frame
/// # Frame::builder().version(V2).sequence(1).system_id(1).component_id(1).message(&Heartbeat::default()).unwrap().build();
///
/// let mav_frame = MavFrame::new(frame.clone());
///
/// frame.try_update_from(&mav_frame).unwrap();
/// # }
/// ```
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum MavFrame {
/// `MAVLink 1` frame.
V1(Frame<V1>),
/// `MAVLink 2` frame.
V2(Frame<V2>),
}
impl MavFrame {
/// Creates [`MavFrame`] from the provided [`Frame`].
pub fn new<V: MaybeVersioned>(frame: Frame<V>) -> Self {
match frame.version() {
MavLinkVersion::V1 => MavFrame::V1(frame.try_into_versioned::<V1>().unwrap()),
MavLinkVersion::V2 => MavFrame::V2(frame.try_into_versioned::<V2>().unwrap()),
}
}
/// `MAVLink` version.
///
/// See: [`Frame::version`].
#[inline]
pub fn version(&self) -> MavLinkVersion {
match self {
MavFrame::V1(_) => MavLinkVersion::V1,
MavFrame::V2(_) => MavLinkVersion::V2,
}
}
/// Payload length.
///
/// See: [`Frame::payload_length`].
#[inline]
pub fn payload_length(&self) -> PayloadLength {
match self {
MavFrame::V1(frame) => frame.payload_length(),
MavFrame::V2(frame) => frame.payload_length(),
}
}
/// Frame sequence.
///
/// See: [`Frame::sequence`].
#[inline]
pub fn sequence(&self) -> Sequence {
match self {
MavFrame::V1(frame) => frame.sequence(),
MavFrame::V2(frame) => frame.sequence(),
}
}
/// System `ID`.
///
/// See: [`Frame::system_id`].
#[inline]
pub fn system_id(&self) -> SystemId {
match self {
MavFrame::V1(frame) => frame.system_id(),
MavFrame::V2(frame) => frame.system_id(),
}
}
/// Component `ID`.
///
/// See: [`Frame::component_id`].
#[inline]
pub fn component_id(&self) -> SystemId {
match self {
MavFrame::V1(frame) => frame.component_id(),
MavFrame::V2(frame) => frame.component_id(),
}
}
/// Message `ID`.
///
/// See: [`Frame::message_id`].
#[inline]
pub fn message_id(&self) -> MessageId {
match self {
MavFrame::V1(frame) => frame.message_id(),
MavFrame::V2(frame) => frame.message_id(),
}
}
/// Payload data.
///
/// See: [`Frame::payload`].
#[inline]
pub fn payload(&self) -> &Payload {
match self {
MavFrame::V1(frame) => frame.payload(),
MavFrame::V2(frame) => frame.payload(),
}
}
/// MAVLink packet checksum.
///
/// See: [`Frame::checksum`].
#[inline]
pub fn checksum(&self) -> Checksum {
match self {
MavFrame::V1(frame) => frame.checksum(),
MavFrame::V2(frame) => frame.checksum(),
}
}
/// Returns `true` if frame is signed.
///
/// For `MAVLink 1` frames always returns `false`.
///
/// See: [`Frame::is_signed`].
#[inline]
pub fn is_signed(&self) -> bool {
match self {
MavFrame::V1(_) => false,
MavFrame::V2(frame) => frame.is_signed(),
}
}
/// `MAVLink 2` signature.
///
/// See: [`Frame::signature`].
#[inline]
pub fn signature(&self) -> Option<&Signature> {
match self {
MavFrame::V1(_) => None,
MavFrame::V2(frame) => frame.signature(),
}
}
/// Removes `MAVLink 2` signature from frame.
///
/// Applicable only for `MAVLink 2` frames. `MAVLink 1` frames will be kept untouched.
///
/// See: [`Frame::remove_signature`].
#[inline]
pub fn remove_signature(&mut self) {
match self {
MavFrame::V1(_) => (),
MavFrame::V2(frame) => frame.remove_signature(),
}
}
/// Body length.
///
/// See: [`Frame::body_length`].
#[inline]
pub fn body_length(&self) -> usize {
match self {
MavFrame::V1(frame) => frame.body_length(),
MavFrame::V2(frame) => frame.body_length(),
}
}
/// Calculates CRC for frame within `crc_extra`.
///
/// See: [`Frame::calculate_crc`].
#[inline]
pub fn calculate_crc(&self, crc_extra: CrcExtra) -> Checksum {
match self {
MavFrame::V1(frame) => frame.calculate_crc(crc_extra),
MavFrame::V2(frame) => frame.calculate_crc(crc_extra),
}
}
/// Validates frame in the context of specific dialect.
///
/// See: [`Frame::validate_checksum`].
#[inline]
pub fn validate_checksum<D: Dialect>(&self) -> Result<()> {
match self {
MavFrame::V1(frame) => frame.validate_checksum::<D>(),
MavFrame::V2(frame) => frame.validate_checksum::<D>(),
}
}
/// Validates frame's checksum using provided `crc_extra`.
///
/// See: [`Frame::validate_checksum_with_crc_extra`].
#[inline]
pub fn validate_checksum_with_crc_extra(
&self,
crc_extra: CrcExtra,
) -> core::result::Result<(), ChecksumError> {
match self {
MavFrame::V1(frame) => frame.validate_checksum_with_crc_extra(crc_extra),
MavFrame::V2(frame) => frame.validate_checksum_with_crc_extra(crc_extra),
}
}
/// Checks that frame has MAVLink version equal to the provided one.
///
/// See: [`Frame::matches_version`]
#[inline]
pub fn matches_version<Version: Versioned>(
&self,
#[allow(unused_variables)] version: Version,
) -> bool {
Version::matches(self.version())
}
/// Decodes frame into a message of particular MAVLink dialect.
///
/// See: [`Frame::decode`].
#[inline]
pub fn decode<D: Dialect>(&self) -> Result<D> {
match self {
MavFrame::V1(frame) => frame.decode(),
MavFrame::V2(frame) => frame.decode(),
}
}
/// Converts [`MavFrame`] into a versionless [`Frame`].
pub fn into_versionless(self) -> Frame<Versionless> {
match self {
MavFrame::V1(frame) => frame.into_versionless(),
MavFrame::V2(frame) => frame.into_versionless(),
}
}
/// Attempts to convert into a versioned form of a [`Frame`].
///
/// Returns [`VersionError`] if conversion is impossible.
pub fn try_into_versioned<V: MaybeVersioned>(
self,
) -> core::result::Result<Frame<V>, VersionError> {
match self {
MavFrame::V1(frame) => frame.try_into_versioned::<V>(),
MavFrame::V2(frame) => frame.try_into_versioned::<V>(),
}
}
}
#[cfg(feature = "unsafe")]
impl<V: MaybeVersioned> TryUpdateFrom<&MavFrame> for Frame<V> {
type Error = VersionError;
fn check_try_update_from(&self, value: &&MavFrame) -> std::result::Result<(), Self::Error> {
V::expect(value.version())
}
unsafe fn update_from_unchecked(&mut self, value: &MavFrame) {
match value {
MavFrame::V1(inner) => {
self.header.payload_length = inner.header.payload_length;
self.header.sequence = inner.header.sequence;
self.header.system_id = inner.header.system_id;
self.header.component_id = inner.header.component_id;
self.header.message_id = inner.header.message_id;
self.payload = inner.payload.clone();
self.checksum = inner.checksum;
}
MavFrame::V2(inner) => {
self.header.payload_length = inner.header.payload_length;
self.header.sequence = inner.header.sequence;
self.header.system_id = inner.header.system_id;
self.header.component_id = inner.header.component_id;
self.header.message_id = inner.header.message_id;
self.payload = inner.payload.clone();
self.checksum = inner.checksum;
self.payload = inner.payload.clone();
self.checksum = inner.checksum;
self.signature = inner.signature.clone();
}
}
}
}
impl<V: MaybeVersioned> TryFrom<MavFrame> for Frame<V> {
type Error = VersionError;
fn try_from(value: MavFrame) -> core::result::Result<Self, VersionError> {
value.try_into_versioned()
}
}
impl<V: MaybeVersioned> From<Frame<V>> for MavFrame {
fn from(value: Frame<V>) -> Self {
Self::new(value)
}
}