Add no-std support

Author: alexmoon

.github/workflows/ci.yaml

@@ -34,6 +34,18 @@ jobs:
         command: check
         args: --all --bins --examples
 
+    - name: check no-std
+      uses: actions-rs/cargo@v1
+      with:
+        command: check
+        args: --all --no-default-features
+
+    - name: check alloc
+      uses: actions-rs/cargo@v1
+      with:
+        command: check
+        args: --all --no-default-features --features alloc
+
     - name: tests
       uses: actions-rs/cargo@v1
       with:

Cargo.toml

@@ -27,12 +27,17 @@ harness = false
 name = "compare"
 harness = false
 
+[features]
+default = ["std"]
+std = ["alloc"]
+alloc = ["bitvec/alloc", "dep:slab", "dep:smallvec"]
+
 [dependencies]
-bitvec = { version = "1.0.1", default-features = false, features = ["alloc"] }
-futures-core = "0.3"
+bitvec = { version = "1.0.1", default-features = false }
+futures-core = { version = "0.3", default-features = false }
 pin-project = "1.0.8"
-slab = "0.4.8"
-smallvec = "1.11.0"
+slab = { version = "0.4.8", optional = true }
+smallvec = { version = "1.11.0", optional = true }
 
 [dev-dependencies]
 async-std = { version = "1.12.0", features = ["attributes"] }

benches/utils/countdown_streams.rs

@@ -42,7 +42,7 @@ pub fn streams_array<const N: usize>() -> [CountdownStream; N] {
     let wakers = Rc::new(RefCell::new(BinaryHeap::new()));
     let completed = Rc::new(Cell::new(0));
     let mut streams =
-        std::array::from_fn(|n| CountdownStream::new(n, N, wakers.clone(), completed.clone()));
+        core::array::from_fn(|n| CountdownStream::new(n, N, wakers.clone(), completed.clone()));
     shuffle(&mut streams);
     streams
 }

src/future/future_group.rs

@@ -1,11 +1,11 @@
+use alloc::collections::BTreeSet;
+use core::fmt::{self, Debug};
+use core::ops::{Deref, DerefMut};
+use core::pin::Pin;
+use core::task::{Context, Poll};
 use futures_core::stream::Stream;
 use futures_core::Future;
 use slab::Slab;
-use std::collections::BTreeSet;
-use std::fmt::{self, Debug};
-use std::ops::{Deref, DerefMut};
-use std::pin::Pin;
-use std::task::{Context, Poll};
 
 use crate::utils::{PollState, PollVec, WakerVec};
 
@@ -237,7 +237,7 @@ impl<F: Future> FutureGroup<F> {
 
         // Set the corresponding state
         self.states[index].set_pending();
-        let mut readiness = self.wakers.readiness().lock().unwrap();
+        let mut readiness = self.wakers.readiness();
         readiness.set_ready(index);
 
         key
@@ -273,7 +273,7 @@ impl<F: Future> FutureGroup<F> {
 impl<F: Future> FutureGroup<F> {
     fn poll_next_inner(
         self: Pin<&mut Self>,
-        cx: &std::task::Context<'_>,
+        cx: &Context<'_>,
     ) -> Poll<Option<(Key, <F as Future>::Output)>> {
         let mut this = self.project();
 
@@ -283,7 +283,7 @@ impl<F: Future> FutureGroup<F> {
         }
 
         // Set the top-level waker and check readiness
-        let mut readiness = this.wakers.readiness().lock().unwrap();
+        let mut readiness = this.wakers.readiness();
         readiness.set_waker(cx.waker());
         if !readiness.any_ready() {
             // Nothing is ready yet
@@ -326,7 +326,7 @@ impl<F: Future> FutureGroup<F> {
                 };
 
                 // Lock readiness so we can use it again
-                readiness = this.wakers.readiness().lock().unwrap();
+                readiness = this.wakers.readiness();
             }
         }
 
@@ -343,10 +343,7 @@ impl<F: Future> FutureGroup<F> {
 impl<F: Future> Stream for FutureGroup<F> {
     type Item = <F as Future>::Output;
 
-    fn poll_next(
-        self: Pin<&mut Self>,
-        cx: &mut std::task::Context<'_>,
-    ) -> Poll<Option<Self::Item>> {
+    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
         match self.poll_next_inner(cx) {
             Poll::Ready(Some((_key, item))) => Poll::Ready(Some(item)),
             Poll::Ready(None) => Poll::Ready(None),
@@ -396,10 +393,7 @@ impl<F: Future> DerefMut for Keyed<F> {
 impl<F: Future> Stream for Keyed<F> {
     type Item = (Key, <F as Future>::Output);
 
-    fn poll_next(
-        self: Pin<&mut Self>,
-        cx: &mut std::task::Context<'_>,
-    ) -> Poll<Option<Self::Item>> {
+    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
         let mut this = self.project();
         this.group.as_mut().poll_next_inner(cx)
     }
@@ -408,8 +402,8 @@ impl<F: Future> Stream for Keyed<F> {
 #[cfg(test)]
 mod test {
     use super::FutureGroup;
+    use core::future;
     use futures_lite::prelude::*;
-    use std::future;
 
     #[test]
     fn smoke() {

src/future/futures_ext.rs

@@ -1,7 +1,7 @@
 use crate::future::Join;
 use crate::future::Race;
+use core::future::IntoFuture;
 use futures_core::Future;
-use std::future::IntoFuture;
 
 use super::join::tuple::Join2;
 use super::race::tuple::Race2;

src/future/join/array.rs

@@ -4,9 +4,9 @@ use crate::utils::{FutureArray, OutputArray, PollArray, WakerArray};
 use core::fmt;
 use core::future::{Future, IntoFuture};
 use core::mem::ManuallyDrop;
+use core::ops::DerefMut;
 use core::pin::Pin;
 use core::task::{Context, Poll};
-use std::ops::DerefMut;
 
 use pin_project::{pin_project, pinned_drop};
 
@@ -93,7 +93,7 @@ where
             "Futures must not be polled after completing"
         );
 
-        let mut readiness = this.wakers.readiness().lock().unwrap();
+        let mut readiness = this.wakers.readiness();
         readiness.set_waker(cx.waker());
         if *this.pending != 0 && !readiness.any_ready() {
             // Nothing is ready yet
@@ -125,7 +125,7 @@ where
                 }
 
                 // Lock readiness so we can use it again
-                readiness = this.wakers.readiness().lock().unwrap();
+                readiness = this.wakers.readiness();
             }
         }
 
@@ -178,12 +178,8 @@ where
 #[cfg(test)]
 mod test {
     use super::*;
-    use crate::utils::DummyWaker;
 
-    use std::future;
-    use std::future::Future;
-    use std::sync::Arc;
-    use std::task::Context;
+    use core::future;
 
     #[test]
     fn smoke() {
@@ -203,7 +199,13 @@ mod test {
     }
 
     #[test]
+    #[cfg(feature = "alloc")]
     fn debug() {
+        use crate::utils::DummyWaker;
+        use alloc::format;
+        use alloc::sync::Arc;
+        use core::task::Context;
+
         let mut fut = [future::ready("hello"), future::ready("world")].join();
         assert_eq!(format!("{:?}", fut), "[Pending, Pending]");
         let mut fut = Pin::new(&mut fut);

src/future/join/mod.rs

@@ -2,6 +2,7 @@ use core::future::Future;
 
 pub(crate) mod array;
 pub(crate) mod tuple;
+#[cfg(feature = "alloc")]
 pub(crate) mod vec;
 
 /// Wait for all futures to complete.

src/future/join/tuple.rs

@@ -3,11 +3,10 @@ use crate::utils::{PollArray, WakerArray};
 
 use core::fmt::{self, Debug};
 use core::future::{Future, IntoFuture};
-use core::mem::MaybeUninit;
+use core::mem::{ManuallyDrop, MaybeUninit};
+use core::ops::DerefMut;
 use core::pin::Pin;
 use core::task::{Context, Poll};
-use std::mem::ManuallyDrop;
-use std::ops::DerefMut;
 
 use pin_project::{pin_project, pinned_drop};
 
@@ -136,7 +135,7 @@ macro_rules! impl_join_tuple {
     };
     ($mod_name:ident $StructName:ident $($F:ident)+) => {
         mod $mod_name {
-            use std::mem::ManuallyDrop;
+            use core::mem::ManuallyDrop;
 
             #[pin_project::pin_project]
             pub(super) struct Futures<$($F,)+> {$(
@@ -199,7 +198,7 @@ macro_rules! impl_join_tuple {
 
                 let mut futures = this.futures.project();
 
-                let mut readiness = this.wakers.readiness().lock().unwrap();
+                let mut readiness = this.wakers.readiness();
                 readiness.set_waker(cx.waker());
 
                 for index in 0..LEN {
@@ -234,7 +233,7 @@ macro_rules! impl_join_tuple {
 
                         return Poll::Ready(out);
                     }
-                    readiness = this.wakers.readiness().lock().unwrap();
+                    readiness = this.wakers.readiness();
                 }
 
                 Poll::Pending
@@ -294,7 +293,7 @@ impl_join_tuple! { join12 Join12 A B C D E F G H I J K L }
 #[cfg(test)]
 mod test {
     use super::*;
-    use std::future;
+    use core::future;
 
     #[test]
     #[allow(clippy::unit_cmp)]
@@ -332,6 +331,7 @@ mod test {
     }
 
     #[test]
+    #[cfg(feature = "std")]
     fn does_not_leak_memory() {
         use core::cell::RefCell;
         use futures_lite::future::pending;

src/future/join/vec.rs

@@ -1,13 +1,13 @@
 use super::Join as JoinTrait;
 use crate::utils::{FutureVec, OutputVec, PollVec, WakerVec};
 
+use alloc::vec::Vec;
 use core::fmt;
 use core::future::{Future, IntoFuture};
+use core::mem::ManuallyDrop;
+use core::ops::DerefMut;
 use core::pin::Pin;
 use core::task::{Context, Poll};
-use std::mem::ManuallyDrop;
-use std::ops::DerefMut;
-use std::vec::Vec;
 
 use pin_project::{pin_project, pinned_drop};
 
@@ -85,7 +85,7 @@ where
             "Futures must not be polled after completing"
         );
 
-        let mut readiness = this.wakers.readiness().lock().unwrap();
+        let mut readiness = this.wakers.readiness();
         readiness.set_waker(cx.waker());
         if *this.pending != 0 && !readiness.any_ready() {
             // Nothing is ready yet
@@ -119,7 +119,7 @@ where
                 }
 
                 // Lock readiness so we can use it again
-                readiness = this.wakers.readiness().lock().unwrap();
+                readiness = this.wakers.readiness();
             }
         }
 
@@ -174,10 +174,12 @@ mod test {
     use super::*;
     use crate::utils::DummyWaker;
 
-    use std::future;
-    use std::future::Future;
-    use std::sync::Arc;
-    use std::task::Context;
+    use alloc::format;
+    use alloc::sync::Arc;
+    use alloc::vec;
+    use core::future;
+    use core::future::Future;
+    use core::task::Context;
 
     #[test]
     fn smoke() {

src/future/mod.rs

@@ -69,6 +69,7 @@
 //! complete, or return an `Err` if *no* futures complete successfully.
 //!
 #[doc(inline)]
+#[cfg(feature = "alloc")]
 pub use future_group::FutureGroup;
 pub use futures_ext::FutureExt;
 pub use join::Join;
@@ -77,6 +78,7 @@ pub use race_ok::RaceOk;
 pub use try_join::TryJoin;
 
 /// A growable group of futures which act as a single unit.
+#[cfg(feature = "alloc")]
 pub mod future_group;
 
 mod futures_ext;