No description
Find a file
Stjepan Glavina 0647de5e8d Tweak docs
2019-08-16 17:18:39 +02:00
benches Initial commit 2019-08-08 14:44:48 +02:00
docs Merge pull request #38 from async-rs/document-blocking 2019-08-16 16:50:14 +02:00
examples Merge pull request #33 from async-rs/remove-time-module 2019-08-16 16:56:47 +02:00
src Tweak docs 2019-08-16 17:18:39 +02:00
tests Formatting 2019-08-14 15:57:51 +02:00
.gitignore Initial commit 2019-08-08 14:44:48 +02:00
.travis.yml Deny warnings on Travis 2019-08-14 03:58:58 +02:00
Cargo.toml Prepare for v0.99.0 2019-08-16 16:59:01 +02:00
CHANGELOG.md Prepare for v0.99.0 2019-08-16 16:59:01 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-08-12 20:02:31 +02:00
LICENSE-APACHE Initial commit 2019-08-08 14:44:48 +02:00
LICENSE-MIT Initial commit 2019-08-08 14:44:48 +02:00
README.md Prepare for v0.99.0 2019-08-16 16:59:01 +02:00
rustfmt.toml Add rustfmt config 2019-08-08 16:04:14 +02:00

Async version of Rust's standard library

Build Status License Cargo Documentation chat

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.

Documentation

async-std comes with extensive API documentation and a book.

Quickstart

Add the following lines to you Cargo.toml:

[dependencies]
async-std = "0.99"

Or use cargo add if you have it installed:

$ cargo add async-std

Hello world

#![feature(async_await)]

use async_std::task;

fn main() {
    task::block_on(async {
        println!("Hello, world!");
    })
}

Low-Friction Sockets with Built-In Timeouts

#![feature(async_await)]

use std::time::Duration;

use async_std::{
    prelude::*,
    task,
    io,
    net::TcpStream,
};

async fn get() -> io::Result<Vec<u8>> {
    let mut stream = TcpStream::connect("example.com:80").await?;
    stream.write_all(b"GET /index.html HTTP/1.0\r\n\r\n").await?;

    let mut buf = vec![];

    io::timeout(Duration::from_secs(5), async {
        stream.read_to_end(&mut buf).await?
        Ok(buf)
    })
}

fn main() {
    task::block_on(async {
        let raw_response = get().await.expect("request");
        let response = String::from_utf8(raw_response)
            .expect("utf8 conversion");
        println!("received: {}", response);
    });
}

Take a look around

Clone the repo:

git clone git@github.com:async-rs/async-std.git && cd async-std

Generate docs:

cargo doc --features docs.rs --open

Check out the examples. To run an example:

cargo run --example hello-world

Contributing

See our contribution document.

License

Licensed under either of

at your option.

Contribution

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 dual licensed as above, without any additional terms or conditions.