Merge branch 'master' into buffer-unordered-adaptable

Author: llebout

.travis.yml

@@ -25,20 +25,21 @@ matrix:
     # This is the minimum Rust version supported by `async-await` feature.
     # When updating this, the reminder to update the minimum required version of `async-await` feature in README.md.
     - name: cargo build --features async-await (minimum required version)
-      rust: beta # 1.39.0
+      rust: 1.39.0
       script:
         - cargo run --manifest-path ci/remove-dev-dependencies/Cargo.toml */Cargo.toml
-        - cargo build --all --features async-await
+        - cargo build --manifest-path futures/Cargo.toml --features async-await
 
     - name: cargo +stable build
       rust: stable
       script:
         - cargo run --manifest-path ci/remove-dev-dependencies/Cargo.toml */Cargo.toml
         # Check default-features
         - cargo build --all
-        # Check compat & thread-pool features
+        # Check compat & thread-pool & async-await features
         - cargo build --manifest-path futures/Cargo.toml --features io-compat
         - cargo build --manifest-path futures/Cargo.toml --features thread-pool
+        - cargo build --manifest-path futures/Cargo.toml --features async-await
 
     - name: cargo +beta build
       rust: beta

CHANGELOG.md

@@ -1,3 +1,27 @@
+# 0.3.1 - 2019-11-7
+* Fix signature of `LocalSpawn` trait (breaking change -- see #1959)
+
+# 0.3.0 - 2019-11-5
+* Stable release along with stable async/await!
+* Added async/await to default features (#1953)
+* Changed `Spawn` trait and `FuturesUnordered::push` to take `&self` (#1950)
+* Moved `Spawn` and `FutureObj` out of `futures-core` and into `futures-task (#1925)
+* Changed case convention for feature names (#1937)
+* Added `executor` feature (#1949)
+* Moved `copy_into`/`copy_buf_into` (#1948)
+* Changed `SinkExt::send_all` to accept a `TryStream` (#1946)
+* Removed `ThreadPool::run` (#1944)
+* Changed to use our own definition of `io::Cursor` (#1943)
+* Removed `BufReader::poll_seek_relative` (#1938)
+* Changed `skip` to take a `usize` rather than `u64` (#1931)
+* Removed `Stream` impl for `VecDeque` (#1930)
+* Renamed `Peekable::peek` to `poll_peek` (#1928)
+* Added immutable iterators for `FuturesUnordered` (#1922)
+* Made `ThreadPool` optional (#1910)
+* Renamed `oneshot::Sender::poll_cancel` to `poll_canceled` (#1908)
+* Added some missing `Clone` implementations
+* Documentation fixes
+
 # 0.3.0-alpha.19 - 2019-9-25
 * Stabilized the `async-await` feature (#1816)
 * Made `async-await` feature no longer require `std` feature (#1815)
@@ -216,7 +240,7 @@
 * `FuturesUnordered` optimization: Since the context stores a `&LocalWaker` reference, it was possible to avoid cloning the `Arc` of the waker
 * Futures-rs now uses Clippy
 * We now use in-band lifetimes
-* The `join!` and `select!` macros are now exposed by the `futures-preview` crate
+* The `join!` and `select!` macros are now exposed by the `futures` crate
 * The project logo was added to the `README.md`
 * `sink::MapErr::get_pinned_mut` is now called `get_pin_mut`
 * We now use the unstable `use_extern_macros` feature for macro reexports

README.md

@@ -11,8 +11,8 @@
     <img alt="Build Status" src="https://travis-ci.com/rust-lang-nursery/futures-rs.svg?branch=master">
   </a>
 
-  <a href="https://crates.io/crates/futures-preview">
-    <img alt="Crates.io" src="https://img.shields.io/crates/v/futures-preview.svg">
+  <a href="https://crates.io/crates/futures">
+    <img alt="Crates.io" src="https://img.shields.io/crates/v/futures.svg">
   </a>
 
   <a href="https://blog.rust-lang.org/2019/07/04/Rust-1.36.0.html">
@@ -21,29 +21,34 @@
 </p>
 
 <p align="center">
-  <a href="https://docs.rs/futures-preview/">
+  <a href="https://docs.rs/futures/">
     Documentation
   </a> | <a href="https://rust-lang-nursery.github.io/futures-rs/">
     Website
   </a>
 </p>
 
+`futures-rs` is a library providing the foundations for asynchronous programming in Rust.
+It includes key trait definitions like `Stream`, as well as utilities like `join!`,
+`select!`, and various futures combinator methods which enable expressive asynchronous
+control flow.
+
 ## Usage
 
 Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-futures-preview = "=0.3.0-alpha.19"
+futures = "0.3"
 ```
 
 Now, you can use futures-rs:
 
 ```rust
-use futures::future::Future; // Note: It's not `futures_preview`
+use futures::future::Future;
 ```
 
-The current futures-rs requires Rust 1.36 or later.
+The current futures-rs requires Rust 1.39 or later.
 
 ### Feature `std`
 
@@ -53,20 +58,9 @@ a `#[no_std]` environment, use:
 
 ```toml
 [dependencies]
-futures-preview = { version = "=0.3.0-alpha.19", default-features = false }
-```
-
-### Feature `async-await`
-
-The `async-await` feature provides several convenient features using async/await. To use futures-rs with async/await, use:
-
-```toml
-[dependencies]
-futures-preview = { version = "=0.3.0-alpha.19", features = ["async-await"] }
+futures = { version = "0.3.1", default-features = false }
 ```
 
-The current `async-await` feature requires Rust 1.39 or later.
-
 # License
 
 This project is licensed under either of

futures-channel/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "futures-channel-preview"
+name = "futures-channel"
 edition = "2018"
-version = "0.3.0-alpha.19"
+version = "0.3.1"
 authors = ["Alex Crichton <alex@alexcrichton.com>"]
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/rust-lang-nursery/futures-rs"
 homepage = "https://rust-lang-nursery.github.io/futures-rs"
-documentation = "https://docs.rs/futures-channel-preview/0.3.0-alpha.19"
+documentation = "https://docs.rs/futures-channel/0.3.0"
 description = """
 Channels for asynchronous communication using futures-rs.
 """
@@ -16,20 +16,20 @@ name = "futures_channel"
 
 [features]
 default = ["std"]
-std = ["alloc", "futures-core-preview/std"]
-alloc = ["futures-core-preview/alloc"]
-sink = ["futures-sink-preview"]
+std = ["alloc", "futures-core/std"]
+alloc = ["futures-core/alloc"]
+sink = ["futures-sink"]
 
 # Unstable features
 # These features are outside of the normal semver guarantees and require the
 # `unstable` feature as an explicit opt-in to unstable API.
-unstable = ["futures-core-preview/unstable"]
-cfg-target-has-atomic = ["futures-core-preview/cfg-target-has-atomic"]
+unstable = ["futures-core/unstable"]
+cfg-target-has-atomic = ["futures-core/cfg-target-has-atomic"]
 
 [dependencies]
-futures-core-preview = { path = "../futures-core", version = "=0.3.0-alpha.19", default-features = false }
-futures-sink-preview = { path = "../futures-sink", version = "=0.3.0-alpha.19", default-features = false, optional = true }
+futures-core = { path = "../futures-core", version = "0.3.1", default-features = false }
+futures-sink = { path = "../futures-sink", version = "0.3.1", default-features = false, optional = true }
 
 [dev-dependencies]
-futures-preview = { path = "../futures", version = "=0.3.0-alpha.19", default-features = true }
-futures-test-preview = { path = "../futures-test", version = "=0.3.0-alpha.19", default-features = true }
+futures = { path = "../futures", version = "0.3.1", default-features = true }
+futures-test = { path = "../futures-test", version = "0.3.1", default-features = true }

futures-channel/src/lib.rs

@@ -17,7 +17,7 @@
 
 #![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]
 
-#![doc(html_root_url = "https://docs.rs/futures-channel-preview/0.3.0-alpha.19")]
+#![doc(html_root_url = "https://docs.rs/futures-channel/0.3.0")]
 
 #[cfg(all(feature = "cfg-target-has-atomic", not(feature = "unstable")))]
 compile_error!("The `cfg-target-has-atomic` feature requires the `unstable` feature as an explicit opt-in to unstable features");

futures-core/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "futures-core-preview"
+name = "futures-core"
 edition = "2018"
-version = "0.3.0-alpha.19"
+version = "0.3.1"
 authors = ["Alex Crichton <alex@alexcrichton.com>"]
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/rust-lang-nursery/futures-rs"
 homepage = "https://rust-lang-nursery.github.io/futures-rs"
-documentation = "https://docs.rs/futures-core-preview/0.3.0-alpha.19"
+documentation = "https://docs.rs/futures-core/0.3.0"
 description = """
 The core traits and types in for the `futures` library.
 """
@@ -28,4 +28,4 @@ cfg-target-has-atomic = []
 [dependencies]
 
 [dev-dependencies]
-futures-preview = { path = "../futures", version = "=0.3.0-alpha.19" }
+futures = { path = "../futures", version = "0.3.1" }

futures-core/src/lib.rs

@@ -11,7 +11,7 @@
 
 #![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]
 
-#![doc(html_root_url = "https://docs.rs/futures-core-preview/0.3.0-alpha.19")]
+#![doc(html_root_url = "https://docs.rs/futures-core/0.3.0")]
 
 #[cfg(all(feature = "cfg-target-has-atomic", not(feature = "unstable")))]
 compile_error!("The `cfg-target-has-atomic` feature requires the `unstable` feature as an explicit opt-in to unstable features");

futures-executor/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "futures-executor-preview"
+name = "futures-executor"
 edition = "2018"
-version = "0.3.0-alpha.19"
+version = "0.3.1"
 authors = ["Alex Crichton <alex@alexcrichton.com>"]
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/rust-lang-nursery/futures-rs"
 homepage = "https://rust-lang-nursery.github.io/futures-rs"
-documentation = "https://docs.rs/futures-executor-preview/0.3.0-alpha.19"
+documentation = "https://docs.rs/futures-executor/0.3.0"
 description = """
 Executors for asynchronous tasks based on the futures-rs library.
 """
@@ -16,14 +16,14 @@ name = "futures_executor"
 
 [features]
 default = ["std"]
-std = ["futures-core-preview/std", "futures-task-preview/std", "futures-util-preview/std"]
+std = ["futures-core/std", "futures-task/std", "futures-util/std"]
 thread-pool = ["std", "num_cpus"]
 
 [dependencies]
-futures-core-preview = { path = "../futures-core", version = "=0.3.0-alpha.19", default-features = false }
-futures-task-preview = { path = "../futures-task", version = "=0.3.0-alpha.19", default-features = false }
-futures-util-preview = { path = "../futures-util", version = "=0.3.0-alpha.19", default-features = false }
+futures-core = { path = "../futures-core", version = "0.3.1", default-features = false }
+futures-task = { path = "../futures-task", version = "0.3.1", default-features = false }
+futures-util = { path = "../futures-util", version = "0.3.1", default-features = false }
 num_cpus = { version = "1.8.0", optional = true }
 
 [dev-dependencies]
-futures-preview = { path = "../futures", version = "=0.3.0-alpha.19" }
+futures = { path = "../futures", version = "0.3.1" }

futures-executor/src/lib.rs

@@ -12,7 +12,7 @@
 
 #![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]
 
-#![doc(html_root_url = "https://docs.rs/futures-executor-preview/0.3.0-alpha.19")]
+#![doc(html_root_url = "https://docs.rs/futures-executor/0.3.0")]
 
 #[cfg(feature = "std")]
 mod local_pool;

futures-executor/src/local_pool.rs

@@ -2,12 +2,12 @@ use crate::enter;
 use futures_core::future::Future;
 use futures_core::stream::Stream;
 use futures_core::task::{Context, Poll};
-use futures_task::{FutureObj, LocalFutureObj, Spawn, LocalSpawn, SpawnError};
 use futures_task::{waker_ref, ArcWake};
+use futures_task::{FutureObj, LocalFutureObj, LocalSpawn, Spawn, SpawnError};
+use futures_util::pin_mut;
 use futures_util::stream::FuturesUnordered;
 use futures_util::stream::StreamExt;
-use futures_util::pin_mut;
-use std::cell::{RefCell};
+use std::cell::RefCell;
 use std::ops::{Deref, DerefMut};
 use std::rc::{Rc, Weak};
 use std::sync::Arc;
@@ -40,7 +40,7 @@ pub struct LocalSpawner {
 type Incoming = RefCell<Vec<LocalFutureObj<'static, ()>>>;
 
 pub(crate) struct ThreadNotify {
-    thread: Thread
+    thread: Thread,
 }
 
 thread_local! {
@@ -58,9 +58,10 @@ impl ArcWake for ThreadNotify {
 // Set up and run a basic single-threaded spawner loop, invoking `f` on each
 // turn.
 fn run_executor<T, F: FnMut(&mut Context<'_>) -> Poll<T>>(mut f: F) -> T {
-    let _enter = enter()
-        .expect("cannot execute `LocalPool` executor from within \
-                 another executor");
+    let _enter = enter().expect(
+        "cannot execute `LocalPool` executor from within \
+         another executor",
+    );
 
     CURRENT_THREAD_NOTIFY.with(|thread_notify| {
         let waker = waker_ref(thread_notify);
@@ -75,9 +76,10 @@ fn run_executor<T, F: FnMut(&mut Context<'_>) -> Poll<T>>(mut f: F) -> T {
 }
 
 fn poll_executor<T, F: FnMut(&mut Context<'_>) -> T>(mut f: F) -> T {
-    let _enter = enter()
-        .expect("cannot execute `LocalPool` executor from within \
-                 another executor");
+    let _enter = enter().expect(
+        "cannot execute `LocalPool` executor from within \
+         another executor",
+    );
 
     CURRENT_THREAD_NOTIFY.with(|thread_notify| {
         let waker = waker_ref(thread_notify);
@@ -98,7 +100,7 @@ impl LocalPool {
     /// Get a clonable handle to the pool as a [`Spawn`].
     pub fn spawner(&self) -> LocalSpawner {
         LocalSpawner {
-            incoming: Rc::downgrade(&self.incoming)
+            incoming: Rc::downgrade(&self.incoming),
         }
     }
 
@@ -164,7 +166,7 @@ impl LocalPool {
     /// use futures::future::{ready, pending};
     ///
     /// let mut pool = LocalPool::new();
-    /// let mut spawner = pool.spawner();
+    /// let spawner = pool.spawner();
     ///
     /// spawner.spawn_local(ready(())).unwrap();
     /// spawner.spawn_local(ready(())).unwrap();
@@ -212,7 +214,7 @@ impl LocalPool {
     /// use futures::future::{ready, pending};
     ///
     /// let mut pool = LocalPool::new();
-    /// let mut spawner = pool.spawner();
+    /// let spawner = pool.spawner();
     ///
     /// spawner.spawn_local(ready(())).unwrap();
     /// spawner.spawn_local(ready(())).unwrap();
@@ -229,7 +231,7 @@ impl LocalPool {
     /// of the pool's run or poll methods. While the function is running, all tasks
     /// in the pool will try to make progress.
     pub fn run_until_stalled(&mut self) {
-        poll_executor(|ctx| { 
+        poll_executor(|ctx| {
             let _ = self.poll_pool(ctx);
         });
     }
@@ -297,7 +299,9 @@ pub fn block_on_stream<S: Stream + Unpin>(stream: S) -> BlockingStream<S> {
 
 /// An iterator which blocks on values from a stream until they become available.
 #[derive(Debug)]
-pub struct BlockingStream<S: Stream + Unpin> { stream: S }
+pub struct BlockingStream<S: Stream + Unpin> {
+    stream: S,
+}
 
 impl<S: Stream + Unpin> Deref for BlockingStream<S> {
     type Target = S;
@@ -332,10 +336,7 @@ impl<S: Stream + Unpin> Iterator for BlockingStream<S> {
 }
 
 impl Spawn for LocalSpawner {
-    fn spawn_obj(
-        &self,
-        future: FutureObj<'static, ()>,
-    ) -> Result<(), SpawnError> {
+    fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError> {
         if let Some(incoming) = self.incoming.upgrade() {
             incoming.borrow_mut().push(future.into());
             Ok(())
@@ -354,10 +355,7 @@ impl Spawn for LocalSpawner {
 }
 
 impl LocalSpawn for LocalSpawner {
-    fn spawn_local_obj(
-        &self,
-        future: LocalFutureObj<'static, ()>,
-    ) -> Result<(), SpawnError> {
+    fn spawn_local_obj(&self, future: LocalFutureObj<'static, ()>) -> Result<(), SpawnError> {
         if let Some(incoming) = self.incoming.upgrade() {
             incoming.borrow_mut().push(future);
             Ok(())