Cleanup comments. (#6)

Author: jettify

justfile

@@ -13,3 +13,9 @@ lint:
 
 ex:
   cargo run --example=local_std
+
+pedantic:
+  cargo clippy -- -W clippy::pedantic
+
+audit:
+  cargo audit

src/packets/baro_altitude.rs

@@ -1,8 +1,3 @@
-//!
-//!     uint16_t altitude_packed;       // Altitude above start (calibration) point
-//!                                     // See description below.
-//!     int8_t   vertical_speed_packed; // vertical speed. See description below.
-
 use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;

src/packets/battery.rs

@@ -2,11 +2,6 @@ use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;
 
-//    int16_t voltage;        // Voltage (LSB = 10 µV)
-//    int16_t current;        // Current (LSB = 10 µA)
-//    uint24_t capacity_used; // Capacity used (mAh)
-//    uint8_t remaining;      // Battery remaining (percent)
-
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Battery {

src/packets/esp_now.rs

@@ -1,9 +1,3 @@
-//    uint8_t VAL1;           // Used for Seat Position of the Pilot
-//    uint8_t VAL2;           // Used for the Current Pilots Lap
-//    char    VAL3[15];       // 15 characters for the lap time current/split
-//    char    VAL4[15];       // 15 characters for the lap time current/split
-//    char    FREE_TEXT[20];  // Free text of 20 character at the bottom of the screen
-//
 use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;

src/packets/gps_extended.rs

@@ -1,15 +1,3 @@
-//    uint8_t fix_type;       // Current GPS fix quality
-//    int16_t n_speed;        // Northward (north = positive) Speed [cm/sec]
-//    int16_t e_speed;        // Eastward (east = positive) Speed [cm/sec]
-//    int16_t v_speed;        // Vertical (up = positive) Speed [cm/sec]
-//    int16_t h_speed_acc;    // Horizontal Speed accuracy cm/sec
-//    int16_t track_acc;      // Heading accuracy in degrees scaled with 1e-1 degrees times 10)
-//    int16_t alt_ellipsoid;  // Meters Height above GPS Ellipsoid (not MSL)
-//    int16_t h_acc;          // horizontal accuracy in cm
-//    int16_t v_acc;          // vertical accuracy in cm
-//    uint8_t reserved;
-//    uint8_t hDOP;           // Horizontal dilution of precision,Dimensionless in nits of.1.
-//    uint8_t vDOP;           // vertical dilution of precision, Dimensionless in nits of .1.
 use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;

src/packets/gps_time.rs

@@ -1,13 +1,3 @@
-//! GpsTime Packet
-//!
-//! int16_t year;
-//! uint8_t month;
-//! uint8_t day;
-//! uint8_t hour;
-//! uint8_t minute;
-//! uint8_t second;
-//! uint16_t millisecond;
-//!
 use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;

src/packets/link_statistics_rx.rs

@@ -1,8 +1,3 @@
-//!   uint8_t rssi_db;        // RSSI (dBm * -1)
-//!   uint8_t rssi_percent;   // RSSI in percent
-//!   uint8_t link_quality;   // Package success rate / Link quality (%)
-//!   int8_t  snr;            // SNR (dB)
-//!   uint8_t rf_power_db;    // rf power in dBm
 use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;

src/packets/vtx_telemetry.rs

@@ -1,15 +1,3 @@
-//!
-//!  uint8_t     up_rssi_ant1;       // Uplink RSSI Antenna 1 (dBm * -1)
-//!  uint8_t     up_rssi_ant2;       // Uplink RSSI Antenna 2 (dBm * -1)
-//!  uint8_t     up_link_quality;    // Uplink Package success rate / Link quality (%)
-//!  int8_t      up_snr;             // Uplink SNR (dB)
-//!  uint8_t     active_antenna;     // number of currently best antenna
-//!  uint8_t     rf_profile;         // enum {4fps = 0 , 50fps, 150fps}
-//!  uint8_t     up_rf_power;        // enum {0mW = 0, 10mW, 25mW, 100mW,
-//!                                  // 500mW, 1000mW, 2000mW, 250mW, 50mW}
-//!  uint8_t     down_rssi;          // Downlink RSSI (dBm * -1)
-//!  uint8_t     down_link_quality;  // Downlink Package success rate / Link quality (%)
-//!  int8_t      down_snr;           // Downlink SNR (dB)
 use crate::packets::CrsfPacket;
 use crate::packets::PacketType;
 use crate::CrsfParsingError;
@@ -49,9 +37,7 @@ impl CrsfPacket for VtxTelemetry {
     }
 
     fn from_bytes(data: &[u8]) -> Result<Self, CrsfParsingError> {
-        if data.len() != Self::MIN_PAYLOAD_SIZE {
-            Err(CrsfParsingError::InvalidPayloadLength)
-        } else {
+        if data.len() == Self::MIN_PAYLOAD_SIZE {
             Ok(Self {
                 up_rssi_ant1: data[0],
                 up_rssi_ant2: data[1],
@@ -64,6 +50,8 @@ impl CrsfPacket for VtxTelemetry {
                 down_link_quality: data[8],
                 down_snr: data[9] as i8,
             })
+        } else {
+            Err(CrsfParsingError::InvalidPayloadLength)
         }
     }
 }

src/parser.rs

@@ -126,7 +126,7 @@ impl CrsfParser {
 
     pub fn reset(&mut self) {
         self.position = 0;
-        self.state = State::AwaitingSync
+        self.state = State::AwaitingSync;
     }
 }