refactor: enable missing_panics_doc clippy lint (#1006)

> Checks the doc comments of publicly visible functions that may panic
and warns if there is no # Panics section.

Co-authored-by: Benoît Cortier <3809077+CBenoit@users.noreply.github.com>

Author: RRRadicalEdward

Cargo.toml

@@ -115,6 +115,7 @@ same_name_method = "warn"
 string_slice = "warn"
 suspicious_xor_used_as_pow = "warn"
 unused_result_ok = "warn"
+missing_panics_doc = "warn"
 
 # == Style, readability == #
 semicolon_outside_block = "warn" # With semicolon-outside-block-ignore-multiline = true

crates/ironrdp-acceptor/src/connection.rs

@@ -123,6 +123,9 @@ impl Acceptor {
         }
     }
 
+    /// # Panics
+    ///
+    /// Panics if state is not [AcceptorState::SecurityUpgrade].
     pub fn mark_security_upgrade_as_done(&mut self) {
         assert!(self.reached_security_upgrade().is_some());
         self.step(&[], &mut WriteBuf::new()).expect("transition to next state");
@@ -133,6 +136,9 @@ impl Acceptor {
         matches!(self.state, AcceptorState::Credssp { .. })
     }
 
+    /// # Panics
+    ///
+    /// Panics if state is not [AcceptorState::Credssp].
     pub fn mark_credssp_as_done(&mut self) {
         assert!(self.should_perform_credssp());
         let res = self.step(&[], &mut WriteBuf::new()).expect("transition to next state");

crates/ironrdp-async/src/connector.rs

@@ -30,6 +30,9 @@ where
     Ok(ShouldUpgrade)
 }
 
+/// # Panics
+///
+/// Panics if connector state is not [ClientConnectorState::EnhancedSecurityUpgrade].
 pub fn skip_connect_begin(connector: &mut ClientConnector) -> ShouldUpgrade {
     assert!(connector.should_perform_security_upgrade());
     ShouldUpgrade

crates/ironrdp-async/src/framed.rs

@@ -115,6 +115,7 @@ where
             if self.buf.len() >= length {
                 return Ok(self.buf.split_to(length));
             } else {
+                #[expect(clippy::missing_panics_doc, reason = "unreachable panic (checked integer underflow)")]
                 self.buf
                     .reserve(length.checked_sub(self.buf.len()).expect("length > self.buf.len()"));
             }

crates/ironrdp-bench/benches/bench.rs

@@ -1,3 +1,5 @@
+#![expect(clippy::missing_panics_doc, reason = "panics in benches are allowed")]
+
 use core::num::{NonZeroU16, NonZeroUsize};
 
 use criterion::{criterion_group, criterion_main, Criterion};

crates/ironrdp-blocking/src/connector.rs

@@ -32,6 +32,9 @@ where
     Ok(ShouldUpgrade)
 }
 
+/// # Panics
+///
+/// Panics if connector state is not [ClientConnectorState::EnhancedSecurityUpgrade].
 pub fn skip_connect_begin(connector: &mut ClientConnector) -> ShouldUpgrade {
     assert!(connector.should_perform_security_upgrade());
     ShouldUpgrade

crates/ironrdp-blocking/src/framed.rs

@@ -51,6 +51,7 @@ where
             if self.buf.len() >= length {
                 return Ok(self.buf.split_to(length));
             } else {
+                #[expect(clippy::missing_panics_doc, reason = "unreachable panic (checked underflow)")]
                 self.buf
                     .reserve(length.checked_sub(self.buf.len()).expect("length > self.buf.len()"));
             }

crates/ironrdp-cliprdr/src/pdu/file_contents.rs

@@ -94,19 +94,13 @@ impl<'a> FileContentsResponse<'a> {
 
     /// Read data as u64 size value
     pub fn data_as_size(&self) -> DecodeResult<u64> {
-        if self.data.len() != 8 {
-            return Err(invalid_field_err!(
-                "requestedFileContentsData",
-                "Invalid data size for u64 size"
-            ));
-        }
+        let chunk = self
+            .data
+            .as_ref()
+            .try_into()
+            .map_err(|_| invalid_field_err!("requestedFileContentsData", "not enough bytes for u64 size"))?;
 
-        Ok(u64::from_le_bytes(
-            self.data
-                .as_ref()
-                .try_into()
-                .expect("data contains exactly eight u8 elements"),
-        ))
+        Ok(u64::from_le_bytes(chunk))
     }
 }
 

crates/ironrdp-connector/src/connection.rs

@@ -176,6 +176,9 @@ impl ClientConnector {
         matches!(self.state, ClientConnectorState::EnhancedSecurityUpgrade { .. })
     }
 
+    /// # Panics
+    ///
+    /// Panics if state is not [ClientConnectorState::EnhancedSecurityUpgrade].
     pub fn mark_security_upgrade_as_done(&mut self) {
         assert!(self.should_perform_security_upgrade());
         self.step(&[], &mut WriteBuf::new()).expect("transition to next state");
@@ -186,6 +189,9 @@ impl ClientConnector {
         matches!(self.state, ClientConnectorState::Credssp { .. })
     }
 
+    /// # Panics
+    ///
+    /// Panics if state is not [ClientConnectorState::Credssp].
     pub fn mark_credssp_as_done(&mut self) {
         assert!(self.should_perform_credssp());
         let res = self.step(&[], &mut WriteBuf::new()).expect("transition to next state");

crates/ironrdp-dvc/src/lib.rs

@@ -73,6 +73,8 @@ pub fn encode_dvc_messages(
 
         while off < total_length {
             let first = off == 0;
+
+            #[expect(clippy::missing_panics_doc, reason = "unreachable panic (checked underflow)")]
             let remaining_length = total_length.checked_sub(off).expect("never overflow");
             let size = core::cmp::min(remaining_length, DrdynvcDataPdu::MAX_DATA_SIZE);
             let end = off