futures-micro-1.0.0-rc0/.cargo_vcs_info.json0000644000000001120000000000100143120ustar { "git": { "sha1": "ca30cb89f2ba1d61d02e3fb522404d1af238a5b5" } } futures-micro-1.0.0-rc0/.gitignore000064400000000000000000000000230072674642500151230ustar 00000000000000/target Cargo.lock futures-micro-1.0.0-rc0/Cargo.toml0000644000000021020000000000100123110ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2018" name = "futures-micro" version = "1.0.0-rc0" authors = ["James Laver "] description = "Minimal, no_std compatible async prelude." homepage = "https://github.com/irrustible/futures-micro" documentation = "https://docs.rs/futures-micro" readme = "README.md" keywords = ["async", "futures", "no-std", "tests", "testing"] categories = ["asynchronous", "concurrency", "no-std"] license = "Apache-2.0 WITH LLVM-exception" repository = "https://github.com/irrustible/futures-micro" [dependencies.pin-project-lite] version = "0.2.4" [dev-dependencies.futures-lite] version = "0.1" futures-micro-1.0.0-rc0/Cargo.toml.orig000064400000000000000000000011410072674642500160240ustar 00000000000000[package] name = "futures-micro" version = "1.0.0-rc0" description = "Minimal, no_std compatible async prelude." keywords = ["async", "futures", "no-std", "tests", "testing"] categories = ["asynchronous", "concurrency", "no-std"] authors = ["James Laver "] homepage = "https://github.com/irrustible/futures-micro" repository = "https://github.com/irrustible/futures-micro" documentation = "https://docs.rs/futures-micro" edition = "2018" license = "Apache-2.0 WITH LLVM-exception" readme = "README.md" [dependencies] pin-project-lite = "0.2.4" [dev-dependencies] futures-lite = "0.1" futures-micro-1.0.0-rc0/LICENSE000064400000000000000000000277470072674642500141660ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---- LLVM Exceptions to the Apache 2.0 License ---- As an exception, if, as a result of your compiling your source code, portions of this Software are embedded into an Object form of such source code, you may redistribute such embedded portions in such Object form without complying with the conditions of Sections 4(a), 4(b) and 4(d) of the License. In addition, if you combine or link compiled forms of this Software with software that is licensed under the GPLv2 ("Combined Software") and if a court of competent jurisdiction determines that the patent provision (Section 3), the indemnity provision (Section 9) or other Section of the License conflicts with the conditions of the GPLv2, you may retroactively and prospectively choose to deem waived or otherwise exclude such Section(s) of the License, but only in their entirety and only with respect to the Combined Software. futures-micro-1.0.0-rc0/README.md000064400000000000000000000054710072674642500144260ustar 00000000000000# futures-micro [![License](https://img.shields.io/crates/l/futures-micro.svg)](https://github.com/irrustible/futures-micro/blob/main/LICENSE) [![Package](https://img.shields.io/crates/v/futures-micro.svg)](https://crates.io/crates/futures-micro) [![Documentation](https://docs.rs/futures-micro/badge.svg)](https://docs.rs/futures-micro) To futures-lite as futures-lite is to futures: smaller. Features: * Fun tools to write everything as async fns. * Tiny, with a single dependency. * 100% `no_std` support, no heap allocation required! * Complete stable compiler support - Uses no nightly features! * Bootstrap tools: * `poll_fn` - wrap a function into a future. * `pin!()` - pin a value to the stack. * Futures interface subversion (poll interface from async fns): * `waker()` to get the current waker. * `sleep()` to wait until you are woken. * Common stuff: * `yield_once()` - lets some other futures do some work . * `or()` - return the result of the first future to complete. * `or!()` - `or()`, but varargs. * `zip()` - return the result of both futures when they both complete. * `zip!()` - `zip()`, but varargs. * `ready!()` - unwraps a ready value or returns pending. ## Status Beta? The API we have here seems pretty reasonable now. If there's something you're missing, you may be looking for [futures-lite](https://github.com/smol-rs/futures-lite). ## Missing/Removed APIs There are many APIs you will *not* find in this crate. Some are absent to keep the crate small and quick to compile, others used to be here but have since been removed. These are: * `pending()` - never completes, now in libcore as `core::future::pending()` * `ready()` - completes on first poll, now in libcore as `core::future::ready()` * `poll_state` - wrap a function and some state into a future. ```rust /// outdated poll_state(INITIAL, |state, ctx| {...}).await /// replacement (NOTE: `*state` should be replaced by `state`) let mut state = INITIAL; poll_fn(move |ctx| { ... }).await ``` ## Changelog ### 0.5.0 - 2021-03-13 * Switch to using `pin-project-lite` for pin projections, removing most of the unsafe code. * Removed `next_poll`. It wasn't very useful and our implementation may not have been sound. This may explain why I can't find it in `futures-lite`. ## Copyright and License Copyright (c) 2020 James Laver, Matthieu le Brazidec, Stjepan Glavina, Erik Zscheile, futures-micro contributors, futures-lite contributors [Licensed](LICENSE) under Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0), with LLVM Exceptions (https://spdx.org/licenses/LLVM-exception.html). Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions. futures-micro-1.0.0-rc0/src/lib.rs000064400000000000000000000214060072674642500150460ustar 00000000000000//! A very small, no-std compatible toolbox of async utilities. #![no_std] #![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)] pub mod prelude; #[doc(no_inline)] pub use core::future::Future; #[doc(no_inline)] pub use core::pin::Pin; #[doc(no_inline)] pub use core::task::{Context, Poll, Waker}; use core::fmt; use pin_project_lite::pin_project; // ---------- futures using the poll api ----------- /// Creates a future from a function returning [`Poll`]. /// /// # Examples /// /// ``` /// use futures_lite::future::block_on; /// use futures_micro::poll_fn; /// use std::task::{Context, Poll}; /// /// # block_on(async { /// fn f(_ctx: &mut Context<'_>) -> Poll { /// Poll::Ready(7) /// } /// /// assert_eq!(poll_fn(f).await, 7); /// # }) /// ``` #[inline(always)] pub fn poll_fn(inner: F) -> PollFn where F: FnMut(&mut Context<'_>) -> Poll, { PollFn { inner } } pin_project! { /// Future for the [`poll_fn()`] function. #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct PollFn { inner: F, } } impl fmt::Debug for PollFn { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("PollFn").finish() } } impl Future for PollFn where F: FnMut(&mut Context<'_>) -> Poll, { type Output = T; fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll { let this = self.project(); (this.inner)(ctx) } } pin_project! { /// Returns the result of `left` or `right` future, preferring `left` if both are ready. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct Or { #[pin] future1: F1, #[pin] future2: F2, } } impl Or where F1: Future, F2: Future, { /// Returns the result of `left` or `right` future, preferring `left` if both are ready. pub fn new(future1: F1, future2: F2) -> Self { Or { future1, future2 } } } impl Future for Or where F1: Future, F2: Future, { type Output = T; fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { let this = self.project(); if let Poll::Ready(t) = this.future1.poll(cx) { Poll::Ready(t) } else if let Poll::Ready(t) = this.future2.poll(cx) { Poll::Ready(t) } else { Poll::Pending } } } pin_project! { /// Waits for two [`Future`]s to complete, returning both results. #[derive(Debug)] #[must_use = "futures do nothing unless you `.await` or poll them"] pub struct Zip where F1: Future, F2: Future, { #[pin] future1: F1, output1: Option, #[pin] future2: F2, output2: Option, } } impl Zip where F1: Future, F2: Future, { /// Zips two futures, waiting for both to complete. /// /// # Examples /// /// ``` /// use futures_micro::Zip; /// /// # futures_lite::future::block_on(async { /// let a = async { 1 }; /// let b = async { 2 }; /// /// assert_eq!(Zip::new(a, b).await, (1, 2)); /// # }) /// ``` pub fn new(future1: F1, future2: F2) -> Self { Zip { future1, future2, output1: None, output2: None, } } } impl Future for Zip where F1: Future, F2: Future, { type Output = (F1::Output, F2::Output); fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { let this = self.project(); if this.output1.is_none() { if let Poll::Ready(out) = this.future1.poll(cx) { *this.output1 = Some(out); } } if this.output2.is_none() { if let Poll::Ready(out) = this.future2.poll(cx) { *this.output2 = Some(out); } } if this.output1.is_some() && this.output2.is_some() { Poll::Ready((this.output1.take().unwrap(), this.output2.take().unwrap())) } else { Poll::Pending } } } /// Get the [`Waker`] inside an async fn where you aren't supposed to /// have it. /// /// This is a low level primitive for implementing more complex /// patterns while avoiding the [`Poll`] API. /// /// # Examples /// /// ``` /// use futures_micro::{sleep, waker}; /// /// # futures_lite::future::block_on(async { /// let waker = waker().await; /// assert_eq!(async { waker.wake(); sleep().await; 1 }.await, 1) /// # }) /// ``` pub fn waker() -> impl Future { poll_fn(|ctx| Poll::Ready(ctx.waker().clone())) } /// Goes to sleep until woken by its [`Waker`] being called. /// /// This is a low level primitive for implementing more complex /// patterns while avoiding the [`Poll`] API. /// /// # Examples /// /// ``` /// use futures_micro::{sleep, waker}; /// /// # futures_lite::future::block_on(async { /// let waker = waker().await; /// assert_eq!(async { waker.wake(); sleep().await; 1 }.await, 1) /// # }) /// ``` pub fn sleep() -> impl Future { let mut done = false; poll_fn(move |_| { if done { Poll::Ready(()) } else { done = true; Poll::Pending } }) } /// Pushes itself to the back of the executor queue so some other /// tasks can do some work. pub fn yield_once() -> impl Future { let mut done = false; poll_fn(move |ctx| { if done { Poll::Ready(()) } else { done = true; ctx.waker().wake_by_ref(); Poll::Pending } }) } // --------- MACROS --------- // Helper for `or!` #[doc(hidden)] #[macro_export] macro_rules! __internal_fold_with { ($func:path, $e:expr) => { $e }; ($func:path, $e:expr, $($es:expr),+) => { $func($e, $crate::__internal_fold_with!($func, $($es),+)) }; } /// Polls arbitrarily many futures, returning the first ready value. /// /// All futures must have the same output type. Left biased when more /// than one Future is ready at the same time. #[macro_export] macro_rules! or { ($($es:expr),+$(,)?) => { $crate::__internal_fold_with!($crate::Or::new, $($es),+) }; } /// Pins a variable of type `T` on the stack and rebinds it as `Pin<&mut T>`. /// /// ``` /// use futures_micro::*; /// use std::fmt::Debug; /// use std::time::Instant; /// /// // Inspects each invocation of `Future::poll()`. /// async fn inspect(f: impl Future) -> T { /// pin!(f); /// poll_fn(|cx| dbg!(f.as_mut().poll(cx))).await /// } /// /// # futures_lite::future::block_on(async { /// let f = async { 1 + 2 }; /// inspect(f).await; /// # }) /// ``` #[macro_export] macro_rules! pin { ($($x:ident),* $(,)?) => { $( let mut $x = $x; #[allow(unused_mut)] let mut $x = unsafe { core::pin::Pin::new_unchecked(&mut $x) }; )* } } /// Unwraps `Poll` or returns [`Pending`][`Poll::Pending`]. /// /// # Examples /// /// ``` /// use futures_micro::*; /// /// // Polls two futures and sums their results. /// fn poll_sum( /// cx: &mut Context<'_>, /// mut a: impl Future + Unpin, /// mut b: impl Future + Unpin, /// ) -> Poll { /// let x = ready!(Pin::new(&mut a).poll(cx)); /// let y = ready!(Pin::new(&mut b).poll(cx)); /// Poll::Ready(x + y) /// } /// ``` #[macro_export] macro_rules! ready { ($e:expr $(,)?) => { match $e { core::task::Poll::Ready(t) => t, t @ core::task::Poll::Pending => return t, } }; } /// Zips arbitrarily many futures, waiting for all to complete. /// /// # Examples /// /// ``` /// use futures_micro::zip; /// /// # futures_lite::future::block_on(async { /// let a = async { 1 }; /// let b = async { 2 }; /// /// assert_eq!(zip!(a, b).await, (1, 2)); /// # }) /// ``` #[macro_export] macro_rules! zip { ($($es:expr),+ $(,)?) => {{ let mut zips = $crate::__internal_fold_with!($crate::Zip::new, $($es),+); $crate::poll_fn(move |ctx| { use ::core::pin::Pin; use ::core::task::Poll; let zips = unsafe { Pin::new_unchecked(&mut zips) }; if let Poll::Ready(val) = ::core::future::Future::poll(zips, ctx) { Poll::Ready($crate::zip!(@flatten; ; val; $($es),+)) } else { Poll::Pending } }) }}; (@flatten; $($prev:expr,)*; $tuple:expr; $e:expr) => { ($($prev,)* $tuple) }; (@flatten; $($prev:expr,)*; $tuple:expr; $e:expr, $($es:expr),+) => { $crate::zip!(@flatten; $($prev,)* $tuple.0,; $tuple.1; $($es),+) }; } futures-micro-1.0.0-rc0/src/prelude.rs000064400000000000000000000013260072674642500157370ustar 00000000000000//! This module has extras that clash with names in [`futures-lite`], //! which depends on us. pub use crate::*; /// Zips two futures, waiting for both to complete. /// /// # Examples /// /// ``` /// use futures_micro::prelude::zip; /// /// # futures_lite::future::block_on(async { /// let a = async { 1 }; /// let b = async { 2 }; /// /// assert_eq!(zip(a, b).await, (1, 2)); /// # }) /// ``` pub fn zip(f1: F1, f2: F2) -> Zip where F1: Future, F2: Future, { Zip::new(f1, f2) } /// Returns the result of `left` or `right` future, preferring `left` if both are ready. pub fn or(future1: F1, future2: F2) -> Or where F1: Future, F2: Future, { Or { future1, future2 } } futures-micro-1.0.0-rc0/tests/test.rs000064400000000000000000000026210072674642500156300ustar 00000000000000#![feature(test)] #![allow(deprecated)] use futures_lite::future::block_on; use futures_micro::{poll_fn, prelude::*}; use std::task::Poll; fn ready(x: T) -> impl Future { let mut x = Some(x); poll_fn(move |_| Poll::Ready(x.take().unwrap())) } fn pending() -> impl Future { poll_fn(|_| Poll::Pending) } #[test] fn waker_sleep_test() { assert!(block_on(async { let waker = waker().await; waker.wake(); sleep().await; true })); } #[test] fn yield_once_test() { assert_eq!( true, block_on(async { yield_once().await; true }) ); assert_eq!( false, block_on(or!( async { yield_once().await; true }, ready(false) )) ); } #[test] fn or_test() { assert_eq!(false, block_on(or(pending::(), ready(false)))); assert_eq!(1, block_on(or!(ready(1), ready(2), ready(3)))); assert_eq!(2, block_on(or!(pending(), ready(2), ready(3)))); assert_eq!(3, block_on(or!(pending(), pending(), ready(3)))); } #[test] fn zip_test() { assert_eq!((true, false), block_on(zip(ready(true), ready(false)))); assert_eq!((1, 2, 3), block_on(zip!(ready(1), ready(2), ready(3)))); assert_eq!( (1, false, 3), block_on(zip!(ready(1), ready(false), ready(3))) ); }