chore: update docs

versatica · Jun 26, 2024 · 72277bb · 72277bb
1 parent d0ccf76
commit 72277bb
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 16 deletions.
diff --git a/rust/src/worker/utils/channel_read_fn.rs b/rust/src/worker/utils/channel_read_fn.rs
@@ -9,6 +9,7 @@ unsafe extern "C" fn free_vec(message: *mut u8, message_len: u32, message_capaci
 }
 
 pub(super) struct ChannelReadCallback {
+    // Silence clippy warnings
     _callback: Box<dyn (FnMut(UvAsyncT) -> Option<Vec<u8>>) + Send + 'static>,
 }
 

diff --git a/rust/src/worker/utils/channel_write_fn.rs b/rust/src/worker/utils/channel_write_fn.rs
@@ -5,8 +5,8 @@ use std::slice;
 /// TypeAlias to silience clippy::type_complexity warnings
 type CallbackType = Box<dyn FnMut(&[u8]) + Send + 'static>;
 
-#[allow(clippy::type_complexity)]
 pub(super) struct ChannelReadCallback {
+    // Silence clippy warnings
     _callback: CallbackType,
 }
 

diff --git a/rust/tests/integration/consumer.rs b/rust/tests/integration/consumer.rs
@@ -292,6 +292,7 @@ fn consumer_device_capabilities() -> RtpCapabilities {
 
 // Keeps executor threads running until dropped
 struct ExecutorGuard {
+    // Silence clippy warnings
     _senders: Vec<async_oneshot::Sender<()>>,
 }
 

diff --git a/rust/tests/integration/webrtc_server.rs b/rust/tests/integration/webrtc_server.rs
@@ -10,6 +10,11 @@ use std::net::{IpAddr, Ipv4Addr};
 use std::sync::atomic::{AtomicUsize, Ordering};
 use std::sync::Arc;
 
+#[derive(Debug, PartialEq)]
+struct CustomAppData {
+    foo: u32,
+}
+
 async fn init() -> (Worker, Worker) {
     {
         let mut builder = env_logger::builder();
@@ -52,11 +57,6 @@ fn create_webrtc_server_succeeds() {
             })
             .detach();
 
-        #[derive(Debug, PartialEq)]
-        struct CustomAppData {
-            foo: u32,
-        }
-
         let webrtc_server = worker1
             .create_webrtc_server({
                 let listen_infos = WebRtcServerListenInfos::new(ListenInfo {
@@ -150,11 +150,6 @@ fn create_webrtc_server_without_specifying_port_succeeds() {
             })
             .detach();
 
-        #[derive(Debug, PartialEq)]
-        struct CustomAppData {
-            foo: u32,
-        }
-
         let webrtc_server = worker1
             .create_webrtc_server({
                 let listen_infos = WebRtcServerListenInfos::new(ListenInfo {
@@ -233,11 +228,6 @@ fn unavailable_infos_fails() {
             })
             .detach();
 
-        // #[derive(Debug, PartialEq)]
-        // struct CustomAppData {
-        //     foo: u32,
-        // }
-
         // Using an unavailable listen IP.
         {
             let create_result = worker1
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     pub(super) struct ChannelReadCallback {
+        // Silence clippy warnings
         _callback: Box<dyn (FnMut(UvAsyncT) -> Option<Vec<u8>>) + Send + 'static>,
     }
@@ Expand Down @@