You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
Katharina Fey 81aa6d152a Changing task::block_on to park after a single poll (#684)
This was previously discussed in #605 and others as a source of high
CPU load when sleeping tasks because of the overhead created by
retrying a future in short succession.
5 years ago
.github Enable doc test on ci 5 years ago
benches Optimization: a slot for the next task to run (#529) 5 years ago
ci Restore Version Sort (#121) 5 years ago
docs fix: Fix typo in documentation 5 years ago
examples remove throttle example 5 years ago
src Changing task::block_on to park after a single poll (#684) 5 years ago
tests fix open_file test code 5 years ago
.gitignore Initial commit 5 years ago
CHANGELOG.md 1.4.0 5 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 5 years ago
Cargo.toml update broadcastor to 1.0.0 (#681) 5 years ago
LICENSE-APACHE Initial commit 5 years ago
LICENSE-MIT Initial commit 5 years ago
README.md Add a section on the async ecosystem to showcase crates that use async-std 5 years ago
bors.toml Remove travis from requirements 5 years ago
rustfmt.toml Run cargo fmt for doc comments (#515) 5 years ago

README.md

async-std

Async version of the Rust standard library


This crate provides an async version of std. It provides all the interfaces you are used to, but in an async version and ready for Rust's async/await syntax.

Features

  • Modern: Built from the ground up for std::future and async/await with blazing fast compilation time.
  • Fast: Our robust allocator and threadpool designs provide ultra-high throughput with predictably low latency.
  • Intuitive: Complete parity with the stdlib means you only need to learn APIs once.
  • Clear: Detailed documentation and accessible guides mean using async Rust was never easier.

Examples

use async_std::task;

async fn say_hello() {
    println!("Hello, world!");
}

fn main() {
    task::block_on(say_hello())
}

More examples, including networking and file access, can be found in our examples directory and in our documentation.

Philosophy

We believe Async Rust should be as easy to pick up as Sync Rust. We also believe that the best API is the one you already know. And finally, we believe that providing an asynchronous counterpart to the standard library is the best way stdlib provides a reliable basis for both performance and productivity.

Async-std is the embodiment of that vision. It combines single-allocation task creation, with an adaptive lock-free executor, threadpool and network driver to create a smooth system that processes work at a high pace with low latency, using Rust's familiar stdlib API.

Installation

With cargo add installed run:

$ cargo add async-std

We also provide a set of "unstable" features with async-std. See the features documentation on how to enable them.

Ecosystem

  • async-tls — Async TLS/SSL streams using Rustls.

  • async-native-tlsNative TLS for Async. Native TLS for futures and async-std.

  • async-tungstenite — Asynchronous WebSockets for async-std, tokio, gio and any std Futures runtime.

  • Tide — Serve the web. A modular web framework built around async/await.

  • SQLx — The Rust SQL Toolkit. SQLx is a 100% safe Rust library for Postgres and MySQL with compile-time checked queries.

  • Surf — Surf the web. Surf is a friendly HTTP client built for casual Rustaceans and veterans alike.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.