MaybeDone::new()

yoshuawuyts · yoshuawuyts · commit 8121fb9f6fbe · 2019-09-16T07:16:10.000+02:00
Signed-off-by: Yoshua Wuyts &lt;yoshuawuyts@gmail.com&gt;
diff --git a/src/join.rs b/src/join.rs
@@ -28,7 +28,7 @@ macro_rules! join {
             $(
                 // Move future into a local so that it is pinned in one place and
                 // is no longer accessible by the end user.
-                let mut $fut = $crate::maybe_done($fut);
+                let mut $fut = $crate::MaybeDone::new($fut);
             )*
             $crate::utils::poll_fn(move |cx| {
                 use $crate::utils::future::Future;
diff --git a/src/lib.rs b/src/lib.rs
@@ -28,7 +28,7 @@ mod select;
 mod try_join;
 mod try_select;
 
-pub use maybe_done::{maybe_done, MaybeDone};
+pub use maybe_done::MaybeDone;
 
 /// Helper re-exports for use in macros.
 pub mod utils {
diff --git a/src/maybe_done.rs b/src/maybe_done.rs
@@ -10,11 +10,6 @@ use core::pin::Pin;
 use futures_core::ready;
 use futures_core::task::{Context, Poll};
 
-/// Create a new instance of `MaybeDone`.
-pub fn maybe_done<Fut: Future>(future: Fut) -> MaybeDone<Fut> {
-    MaybeDone::Future(future)
-}
-
 /// A future that may have completed.
 #[derive(Debug)]
 pub enum MaybeDone<Fut: Future> {
@@ -28,10 +23,16 @@ pub enum MaybeDone<Fut: Future> {
 }
 
 impl<Fut: Future> MaybeDone<Fut> {
+    /// Create a new instance of `MaybeDone`.
+    pub fn new(future: Fut) -> MaybeDone<Fut> {
+        Self::Future(future)
+    }
+
     /// Returns an [`Option`] containing a mutable reference to the output of the future.
     /// The output of this method will be [`Some`] if and only if the inner
     /// future has been completed and [`take`](MaybeDone::take)
     /// has not yet been called.
+    #[allow(clippy::wrong_self_convention)]
     #[inline]
     pub fn as_mut(self: Pin<&mut Self>) -> Option<&mut Fut::Output> {
         unsafe {
@@ -47,6 +48,7 @@ impl<Fut: Future> MaybeDone<Fut> {
     /// The output of this method will be [`Some`] if and only if the inner
     /// future has been completed and [`take`](MaybeDone::take)
     /// has not yet been called.
+    #[allow(clippy::wrong_self_convention)]
     #[inline]
     pub fn as_ref(self: Pin<&Self>) -> Option<&Fut::Output> {
         let this = self.get_ref();
diff --git a/src/select.rs b/src/select.rs
@@ -35,7 +35,7 @@ macro_rules! select {
             $(
                 // Move future into a local so that it is pinned in one place and
                 // is no longer accessible by the end user.
-                let mut $fut = $crate::maybe_done($fut);
+                let mut $fut = $crate::MaybeDone::new($fut);
             )*
             $crate::utils::poll_fn(move |cx| {
                 use $crate::utils::future::Future;
diff --git a/src/try_join.rs b/src/try_join.rs
@@ -52,7 +52,7 @@ macro_rules! try_join {
             $(
                 // Move future into a local so that it is pinned in one place and
                 // is no longer accessible by the end user.
-                let mut $fut = $crate::maybe_done($fut);
+                let mut $fut = $crate::MaybeDone::new($fut);
             )*
 
             let res: Result<_, _> = poll_fn(move |cx| {
diff --git a/src/try_select.rs b/src/try_select.rs
@@ -6,7 +6,7 @@
 ///
 /// `try_select!` is similar to [`select!`], but keeps going if a future
 /// resolved to an error until all futures have been resolved. In which case
-/// the last error found will be returned.
+/// the error of the last item in the list will be returned.
 ///
 /// This macro is only usable inside of async functions, closures, and blocks.
 ///
@@ -42,7 +42,7 @@ macro_rules! try_select {
             $(
                 // Move future into a local so that it is pinned in one place and
                 // is no longer accessible by the end user.
-                let mut $fut = $crate::maybe_done($fut);
+                let mut $fut = $crate::MaybeDone::new($fut);
             )*
 
             let res: Result<_, _> = poll_fn(move |cx| {
