add missing docs & additional forbid/deny restrictions

Author: rursprung

src/accelerometer_event.rs

@@ -3,6 +3,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents an accelerometer event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub struct AccelerometerEvent {
     x: f32,
     y: f32,
@@ -29,6 +30,7 @@ impl TryFrom<&[u8]> for AccelerometerEvent {
     }
 }
 
+#[allow(missing_docs)] // the names are already obvious enough
 impl AccelerometerEvent {
     pub fn x(&self) -> f32 {
         self.x

src/button_event.rs

@@ -4,13 +4,16 @@ use super::ProtocolParseError;
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum ButtonParseError {
+    /// The message contained an unknown button. For the known buttons see [`Button`].
     UnknownButton(u8),
+    /// The message contained an unknown button state. For the known button states see [`ButtonState`].
     UnknownButtonState(u8),
 }
 
 /// Lists all possible buttons which can be sent in the event.
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub enum Button {
     Button1,
     Button2,
@@ -42,6 +45,7 @@ impl Button {
 /// The state of the button.
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub enum ButtonState {
     Released,
     Pressed,
@@ -61,6 +65,7 @@ impl ButtonState {
 /// Represents a button event from the protocol.
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub struct ButtonEvent {
     button: Button,
     state: ButtonState,
@@ -86,6 +91,7 @@ impl TryFrom<&[u8]> for ButtonEvent {
     }
 }
 
+#[allow(missing_docs)] // the names are already obvious enough
 impl ButtonEvent {
     pub fn button(&self) -> &Button {
         &self.button

src/color_event.rs

@@ -3,6 +3,7 @@ use super::ProtocolParseError;
 /// Represents a color event from the protocol.
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub struct ColorEvent {
     red: u8,
     green: u8,
@@ -29,6 +30,7 @@ impl TryFrom<&[u8]> for ColorEvent {
     }
 }
 
+#[allow(missing_docs)] // the names are already obvious enough
 impl ColorEvent {
     pub fn red(&self) -> u8 {
         self.red

src/gyro_event.rs

@@ -3,6 +3,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents a gyro event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub struct GyroEvent {
     x: f32,
     y: f32,
@@ -29,6 +30,7 @@ impl TryFrom<&[u8]> for GyroEvent {
     }
 }
 
+#[allow(missing_docs)] // the names are already obvious enough
 impl GyroEvent {
     pub fn x(&self) -> f32 {
         self.x

src/lib.rs

@@ -1,7 +1,13 @@
-//! Implements the [Controller Protocol](https://learn.adafruit.com/bluefruit-le-connect/controller) from Adafruit.
+//! Implements the [Controller Protocol](https://learn.adafruit.com/bluefruit-le-connect/controller) from Adafruit
+//! which is e.g. used by the [Adafruit Bluefruit LE UART Friend](https://learn.adafruit.com/introducing-the-adafruit-bluefruit-le-uart-friend).
 
-#![deny(unsafe_code)]
+#![forbid(unsafe_code)]
+// use deny instead of forbid due to bogus warnings, see also https://github.com/rust-lang/rust/issues/81670
 #![deny(warnings)]
+#![deny(missing_docs)]
+#![forbid(missing_debug_implementations)]
+// use deny instead of forbid due to bogus warnings, see also https://github.com/rust-lang/rust/issues/81670
+#![deny(unused)]
 #![no_std]
 
 mod accelerometer_event;
@@ -25,6 +31,7 @@ pub use quaternion_event::QuaternionEvent;
 /// Lists all (supported) events which can be sent by the controller. These come with the parsed event data and are the result of a [`parse`] call.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub enum ControllerEvent {
     ButtonEvent(ButtonEvent),
     ColorEvent(ColorEvent),
@@ -39,16 +46,22 @@ pub enum ControllerEvent {
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum ProtocolParseError {
+    /// The message contained an event which is not known to the current implementation. This can either mean that the message was malformed or that a newer protocol version has been used.
     UnknownEvent(Option<u8>),
+    /// An error occurred while parsing a [`ButtonEvent`].
     ButtonParseError(ButtonParseError),
+    /// The event in the message did not have the expected length.
     InvalidLength(usize, usize),
+    /// The event in the message did not have the expected CRC.
     InvalidCrc(u8, u16),
+    /// There was a problem parsing a float from a message.
     InvalidFloatSize(usize),
 }
 
-/// Lists all (supported) data packages which can be sent by the controller. Internal state used during parsing. Use [`ControllerEvent`] to return the actual event.
+/// Lists all data packages which can be sent by the controller. Internal state used during parsing. Use [`ControllerEvent`] to return the actual event.
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 enum ControllerDataPackageType {
     ButtonCommand,
     Color,
@@ -143,7 +156,7 @@ fn parse_command(
     command: ControllerDataPackageType,
     command_input: &[u8],
 ) -> Result<ControllerEvent, ProtocolParseError> {
-    #[cfg(feature="defmt")]
+    #[cfg(feature = "defmt")]
     defmt::debug!(
         "parsing the command of type {} from message {:a}",
         command,
@@ -193,7 +206,7 @@ fn parse_command(
 
 /// Check the CRC of a command
 fn check_crc(data: &[u8], crc: &u8) -> Result<(), ProtocolParseError> {
-    #[cfg(feature="defmt")]
+    #[cfg(feature = "defmt")]
     defmt::trace!("calculating CRC for {:a}, expecting {}", data, crc);
 
     let mut sum: u16 = 0;

src/location_event.rs

@@ -3,6 +3,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents a location event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub struct LocationEvent {
     latitude: f32,
     longitude: f32,
@@ -29,6 +30,7 @@ impl TryFrom<&[u8]> for LocationEvent {
     }
 }
 
+#[allow(missing_docs)] // the names are already obvious enough
 impl LocationEvent {
     pub fn latitude(&self) -> f32 {
         self.latitude

src/magnetometer_event.rs

@@ -3,6 +3,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents a magnetometer event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub struct MagnetometerEvent {
     x: f32,
     y: f32,
@@ -29,6 +30,7 @@ impl TryFrom<&[u8]> for MagnetometerEvent {
     }
 }
 
+#[allow(missing_docs)] // the names are already obvious enough
 impl MagnetometerEvent {
     pub fn x(&self) -> f32 {
         self.x

src/quaternion_event.rs

@@ -1,8 +1,9 @@
 use super::{try_f32_from_le_bytes, ProtocolParseError};
 
-/// Represents a quaternion event from the protocol.
+/// Represents a [quaternion](https://en.wikipedia.org/wiki/Quaternion) event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(missing_docs)] // the names are already obvious enough
 pub struct QuaternionEvent {
     x: f32,
     y: f32,
@@ -31,6 +32,7 @@ impl TryFrom<&[u8]> for QuaternionEvent {
     }
 }
 
+#[allow(missing_docs)] // the names are already obvious enough
 impl QuaternionEvent {
     pub fn x(&self) -> f32 {
         self.x