Warn for uses of futures_util::stream::FuturesUnordered

nimiq · Aug 2, 2024 · 3948e91 · 3948e91
1 parent 1dbade2
commit 3948e91
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/clippy.toml b/clippy.toml
@@ -0,0 +1,7 @@
+[[disallowed-types]]
+path = "futures_util::stream::FuturesUnordered"
+reason = "use `nimiq_utils::stream::FuturesUnordered` instead, it does not need manual `Waker`s"
+
+[[disallowed-types]]
+path = "futures_util::stream::FuturesOrdered"
+reason = "use `nimiq_utils::stream::FuturesOrdered` instead, it does not need manual `Waker`s"
diff --git a/utils/src/stream.rs b/utils/src/stream.rs
@@ -1,3 +1,7 @@
+// We need to silence this lint because we're using the original
+// `FuturesOrdered` and `FuturesUnordered` in this module to reimplement them.
+#![allow(clippy::disallowed_types)]
+
 use std::{
     future::Future,
     pin::Pin,