Expose FuturesUnorderedIter*Mut

Author: taiki-e

futures-util/src/stream/futures_unordered/iter.rs

@@ -5,17 +5,17 @@ use core::pin::Pin;
 
 #[derive(Debug)]
 /// Mutable iterator over all futures in the unordered set.
-pub struct IterPinMut<'a, Fut> {
+pub struct FuturesUnorderedIterPinMut<'a, Fut> {
     pub(super) task: *const Task<Fut>,
     pub(super) len: usize,
     pub(super) _marker: PhantomData<&'a mut FuturesUnordered<Fut>>
 }
 
 #[derive(Debug)]
 /// Mutable iterator over all futures in the unordered set.
-pub struct IterMut<'a, Fut: Unpin> (pub(super) IterPinMut<'a, Fut>);
+pub struct FuturesUnorderedIterMut<'a, Fut: Unpin> (pub(super) FuturesUnorderedIterPinMut<'a, Fut>);
 
-impl<'a, Fut> Iterator for IterPinMut<'a, Fut> {
+impl<'a, Fut> Iterator for FuturesUnorderedIterPinMut<'a, Fut> {
     type Item = Pin<&'a mut Fut>;
 
     fn next(&mut self) -> Option<Pin<&'a mut Fut>> {
@@ -36,9 +36,9 @@ impl<'a, Fut> Iterator for IterPinMut<'a, Fut> {
     }
 }
 
-impl<Fut> ExactSizeIterator for IterPinMut<'_, Fut> {}
+impl<Fut> ExactSizeIterator for FuturesUnorderedIterPinMut<'_, Fut> {}
 
-impl<'a, Fut: Unpin> Iterator for IterMut<'a, Fut> {
+impl<'a, Fut: Unpin> Iterator for FuturesUnorderedIterMut<'a, Fut> {
     type Item = &'a mut Fut;
 
     fn next(&mut self) -> Option<&'a mut Fut> {
@@ -50,4 +50,4 @@ impl<'a, Fut: Unpin> Iterator for IterMut<'a, Fut> {
     }
 }
 
-impl<Fut: Unpin> ExactSizeIterator for IterMut<'_, Fut> {}
+impl<Fut: Unpin> ExactSizeIterator for FuturesUnorderedIterMut<'_, Fut> {}

futures-util/src/stream/futures_unordered/mod.rs

@@ -19,7 +19,7 @@ use alloc::sync::{Arc, Weak};
 mod abort;
 
 mod iter;
-use self::iter::{IterMut, IterPinMut};
+pub use self::iter::{FuturesUnorderedIterMut, FuturesUnorderedIterPinMut};
 
 mod task;
 use self::task::Task;
@@ -190,14 +190,14 @@ impl<Fut> FuturesUnordered<Fut> {
     }
 
     /// Returns an iterator that allows modifying each future in the set.
-    pub fn iter_mut(&mut self) -> IterMut<'_, Fut> where Fut: Unpin {
-        IterMut(Pin::new(self).iter_pin_mut())
+    pub fn iter_mut(&mut self) -> FuturesUnorderedIterMut<'_, Fut> where Fut: Unpin {
+        FuturesUnorderedIterMut(Pin::new(self).iter_pin_mut())
     }
 
     /// Returns an iterator that allows modifying each future in the set.
     #[allow(clippy::needless_lifetimes)] // https://github.com/rust-lang/rust/issues/52675
-    pub fn iter_pin_mut<'a>(self: Pin<&'a mut Self>) -> IterPinMut<'a, Fut> {
-        IterPinMut {
+    pub fn iter_pin_mut<'a>(self: Pin<&'a mut Self>) -> FuturesUnorderedIterPinMut<'a, Fut> {
+        FuturesUnorderedIterPinMut {
             task: self.head_all,
             len: self.len(),
             _marker: PhantomData

futures-util/src/stream/mod.rs

@@ -128,7 +128,11 @@ cfg_target_has_atomic! {
     #[cfg(feature = "alloc")]
     mod futures_unordered;
     #[cfg(feature = "alloc")]
-    pub use self::futures_unordered::{futures_unordered, FuturesUnordered};
+    #[doc(inline)]
+    pub use self::futures_unordered::{
+        futures_unordered, FuturesUnordered, FuturesUnorderedIterMut,
+        FuturesUnorderedIterPinMut,
+    };
 
     #[cfg(feature = "alloc")]
     mod split;