refactor: enable `missing_panics_doc` clippy lint #1006

RRRadicalEdward · 2025-10-03T07:54:13Z

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

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

github-actions · 2025-10-03T07:59:50Z

Coverage Report 🤖 ⚙️

Past:
Total lines: 26085
Covered lines: 15289 (58.61%)

New:
Total lines: 26079
Covered lines: 15285 (58.61%)

Diff: -0.00%

[this comment will be updated automatically]

crates/ironrdp-acceptor/src/connection.rs

CBenoit · 2025-10-03T09:56:02Z

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

+        Ok(u64::from_le_bytes(self.data.as_ref().try_into().map_err(|_| {
+            invalid_field_err!(
                "requestedFileContentsData",
-                "Invalid data size for u64 size"
-            ));
-        }
-
-        Ok(u64::from_le_bytes(
-            self.data
-                .as_ref()
-                .try_into()
-                .expect("data contains exactly eight u8 elements"),
-        ))
+                "Can't cast self.data to u64 via &[u8, 8], invalid data size"
+            )
+        })?))


suggestion: I think this is the most readable as of today:

let chunk = self.data.first_chunk::<8>().ok_or_else(|| invalid_field_err!( "requestedFileContentsData", "not enough bytes for u64 size" ))?; Ok(u64::from_le_bytes(chunk))

I changed it to use try_into. The way it was, but without the expect.

crates/ironrdp-graphics/src/color_conversion.rs

crates/ironrdp-mstsgu/src/lib.rs

crates/ironrdp-pdu/src/gcc/network_data.rs

crates/ironrdp-session/src/fast_path.rs

CBenoit · 2025-10-03T10:05:13Z

ffi/src/log.rs

+        /// # Panics
+        ///
+        /// If log directory creation fails.
+        ///
+        /// If tracing initialization fails.
        pub fn init_with_env() {


issue: It’s actually not okay to panic here. Can you add a FIXME?

Done. Does it look good?

RRRadicalEdward added 2 commits October 3, 2025 10:53

refactor: enable missing_panics_doc clippy lint

2e4bdb5

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

fix typo

32cfd69

RRRadicalEdward requested a review from CBenoit October 3, 2025 08:05

RRRadicalEdward self-assigned this Oct 3, 2025