Merge branch 'master' into buf-writer

Author: Drevoed

.travis.yml

@@ -3,24 +3,66 @@ language: rust
 env:
   - RUSTFLAGS="-D warnings"
 
-before_script:
-  - rustup component add rustfmt
+# Cache the whole `~/.cargo` directory to keep `~/cargo/.crates.toml`.
+cache:
+  directories:
+    - /home/travis/.cargo
+
+# Don't cache the cargo registry because it's too big.
+before_cache:
+  - rm -rf /home/travis/.cargo/registry
+
+
+branches:
+  only:
+    - master
+    - staging
+    - trying
 
 matrix:
   fast_finish: true
   include:
     - rust: nightly
       os: linux
-      env: BUILD_DOCS=1
+
     - rust: nightly
       os: osx
       osx_image: xcode9.2
-      env: BUILD_DOCS=1
+
     - rust: nightly-x86_64-pc-windows-msvc
       os: windows
 
+    - name: fmt
+      rust: nightly
+      os: linux
+      before_script: |
+        if ! rustup component add rustfmt; then
+          target=`curl https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/rustfmt`;
+          echo "'rustfmt' is unavailable on the toolchain 'nightly', use the toolchain 'nightly-$target' instead";
+          rustup toolchain install nightly-$target;
+          rustup default nightly-$target;
+          rustup component add rustfmt;
+        fi
+      script:
+        - cargo fmt --all -- --check
+
+    - name: docs
+      rust: nightly
+      os: linux
+      script:
+        - cargo doc --features docs unstable
+
+    - name: book
+      rust: nightly
+      os: linux
+      before_script:
+        - test -x $HOME/.cargo/bin/mdbook || ./ci/install-mdbook.sh
+        - cargo build # to find 'extern crate async_std' by `mdbook test`
+      script:
+        - mdbook build docs
+        - mdbook test -L ./target/debug/deps docs
+
 script:
   - cargo check --all --benches --bins --examples --tests
-  - cargo test --all
-  - cargo fmt --all -- --check
-  - if [[ -n "$BUILD_DOCS" ]]; then cargo doc --features docs; fi
+  - cargo check --features unstable --all --benches --bins --examples --tests
+  - cargo test --all --doc --features unstable

CHANGELOG.md

@@ -1,3 +1,89 @@
-# Version 0.99.3
+# Changelog
+
+All notable changes to async-std will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://book.async.rs/overview/stability-guarantees.html).
+
+## [Unreleased]
+
+# [0.99.6] - 2019-09-19
+
+## Added
+
+- Added `stream::Stream::collect` as "unstable"
+- Added `stream::Stream::enumerate`
+- Added `stream::Stream::fuse`
+- Added `stream::Stream::fold`
+- Added `stream::Stream::scan`
+- Added `stream::Stream::zip`
+- Added `stream::join` macro as "unstable"
+- Added `stream::DoubleEndedStream` as "unstable"
+- Added `stream::FromStream` trait as "unstable"
+- Added `stream::IntoStream` trait as "unstable"
+- Added `io::Cursor` as "unstable"
+- Added `io::BufRead::consume` method
+- Added `io::repeat`
+- Added `io::Slice` and `io::SliceMut`
+- Added documentation for feature flags
+- Added `pin` submodule as "unstable"
+- Added the ability to `collect` a stream of `Result<T, E>`s into a
+  `Result<impl FromStream<T>, E>`
+
+## Changed
+
+- Refactored the scheduling algorithm of our executor to use work stealing
+- Refactored the network driver, removing 400 lines of code
+- Removed the `Send` bound from `task::block_on`
+- Removed `Unpin` bound from `impl<T: futures::stream::Stream> Stream for T`
+
+# [0.99.5] - 2019-09-12
+
+## Added
+
+- Added tests for `io::timeout`
+- Added `io::BufRead::fill_buf`, an `async fn` counterpart to `poll_fill_buf`
+- Added `fs::create_dir_all`
+- Added `future::timeout`, a free function to time out futures after a threshold
+- Added `io::prelude`
+- Added `net::ToSocketAddrs`, a non-blocking version of std's `ToSocketAddrs`
+- Added `stream::Stream::all`
+- Added `stream::Stream::filter_map`
+- Added `stream::Stream::find_map`
+- Added `stream::Stream::find`
+- Added `stream::Stream::min_by`
+- Added `stream::Stream::nth`
+
+## Changed
+
+- Polished the text and examples of the tutorial
+- `cargo fmt` on all examples
+- Simplified internals of `TcpStream::connect_to`
+- Modularized our CI setup, enabled a rustfmt fallback, and improved caching
+- Reduced our dependency on the `futures-rs` crate, improving compilation times
+- Split `io::Read`, `io::Write`, `io::BufRead`, and `stream::Stream` into
+  multiple files
+- `fs::File` now flushes more often to prevent flushes during `seek`
+- Updated all dependencies
+- Fixed a bug in the conversion of `File` into raw handle
+- Fixed compilation errors on the latest nightly
+
+## Removed
+
+# [0.99.4] - 2019-08-21
+
+## Changes
+
+- Many small changes in the book, mostly typos
+- Documentation fixes correcting examples
+- Now works with recent nightly with stabilised async/await (> 2019-08-21)
+
+# [0.99.3] - 2019-08-16
 
 - Initial beta release
+
+[Unreleased]: https://github.com/async-rs/async-std/compare/v0.99.6...HEAD
+[0.99.6]: https://github.com/async-rs/async-std/compare/v0.99.5...0.99.6
+[0.99.5]: https://github.com/async-rs/async-std/compare/v0.99.4...v0.99.5
+[0.99.4]: https://github.com/async-rs/async-std/compare/v0.99.3...v0.99.4
+[0.99.3]: https://github.com/async-rs/async-std/tree/v0.99.3

Cargo.toml

@@ -1,9 +1,10 @@
 [package]
 name = "async-std"
-version = "0.99.3"
+version = "0.99.6"
 authors = [
   "Stjepan Glavina <[email protected]>",
-  "The async-std Project Developers",
+  "Yoshua Wuyts <[email protected]>",
+  "Contributors to async-std",
 ]
 edition = "2018"
 license = "Apache-2.0/MIT"
@@ -21,23 +22,36 @@ rustdoc-args = ["--cfg", "feature=\"docs\""]
 
 [features]
 docs = []
+unstable = []
 
 [dependencies]
+async-macros = "1.0.0"
 async-task = "1.0.0"
 cfg-if = "0.1.9"
 crossbeam-channel = "0.3.9"
-futures-preview = "0.3.0-alpha.17"
-futures-timer = "0.3.0"
-lazy_static = "1.3.0"
+crossbeam-deque = "0.7.1"
+futures-core-preview = "0.3.0-alpha.18"
+futures-io-preview = "0.3.0-alpha.18"
+futures-timer = "0.4.0"
+lazy_static = "1.4.0"
 log = { version = "0.4.8", features = ["kv_unstable"] }
 memchr = "2.2.1"
 mio = "0.6.19"
 mio-uds = "0.6.7"
-num_cpus = "1.10.0"
+num_cpus = "1.10.1"
 pin-utils = "0.1.0-alpha.4"
 slab = "0.4.2"
-surf = "1.0.1"
+kv-log-macro = "1.0.4"
 
 [dev-dependencies]
-femme = "1.1.0"
+femme = "1.2.0"
+surf = "1.0.2"
 tempdir = "0.3.7"
+
+# These are used by the book for examples
+futures-channel-preview = "0.3.0-alpha.18"
+futures-util-preview = "0.3.0-alpha.18"
+
+[dev-dependencies.futures-preview]
+version = "0.3.0-alpha.18"
+features = ["std", "nightly", "async-await"]

README.md

@@ -1,4 +1,4 @@
-# Async version of Rust's standard library
+# Async version of the Rust standard library
 
 [![Build Status](https://travis-ci.com/async-rs/async-std.svg?branch=master)](https://travis-ci.com/async-rs/async-std)
 [![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/async-rs/async-std)
@@ -20,7 +20,7 @@ are used to, but in an async version and ready for Rust's `async`/`await` syntax
 
 ## Quickstart
 
-Add the following lines to you `Cargo.toml`:
+Add the following lines to your `Cargo.toml`:
 
 ```toml
 [dependencies]
@@ -38,8 +38,6 @@ $ cargo add async-std
 ## Hello world
 
 ```rust
-#![feature(async_await)]
-
 use async_std::task;
 
 fn main() {
@@ -52,8 +50,6 @@ fn main() {
 ## Low-Friction Sockets with Built-In Timeouts
 
 ```rust
-#![feature(async_await)]
-
 use std::time::Duration;
 
 use async_std::{
@@ -70,9 +66,9 @@ async fn get() -> io::Result<Vec<u8>> {
     let mut buf = vec![];
 
     io::timeout(Duration::from_secs(5), async {
-        stream.read_to_end(&mut buf).await?
+        stream.read_to_end(&mut buf).await?;
         Ok(buf)
-    })
+    }).await
 }
 
 fn main() {
@@ -85,6 +81,25 @@ fn main() {
 }
 ```
 
+## Features
+
+`async-std` is strongly commited to following semver. This means your code won't
+break unless _you_ decide to upgrade.
+
+However every now and then we come up with something that we think will work
+_great_ for `async-std`, and we want to provide a sneak-peek so you can try it
+out. This is what we call _"unstable"_ features. You can try out the unstable
+features by enabling the `unstable` feature in your `Cargo.toml` file:
+
+```toml
+[dependencies.async-std]
+version = "0.99"
+features = ["unstable"]
+```
+
+Just be careful when using these features, as they may change between
+versions.
+
 ## Take a look around
 
 Clone the repo:

benches/task_local.rs

@@ -1,4 +1,4 @@
-#![feature(async_await, test)]
+#![feature(test)]
 
 extern crate test;
 

bors.toml

@@ -0,0 +1 @@
+status = ["continuous-integration/travis-ci/push"]

ci/install-mdbook.sh

@@ -0,0 +1,19 @@
+set -euxo pipefail
+
+# Based on the Rust-Embedded WG's book CI
+# https://github.com/rust-embedded/book/blob/master/ci/install.sh
+
+main() {
+    # Note - this will only accept releases tagged with v0.3.x
+    local tag=$(git ls-remote --tags --refs --exit-code \
+                    https://github.com/rust-lang-nursery/mdbook \
+                        | cut -d/ -f3 \
+                        | grep -E '^v0\.3\.[0-9]+$' \
+                        | sort --version-sort \
+                        | tail -n1)
+
+    curl -LSfs https://japaric.github.io/trust/install.sh | \
+        sh -s -- --git rust-lang-nursery/mdbook --tag $tag
+}
+
+main