forked from mirror/async-std
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.
4241f64b1b
189: links the timeout docs to each other r=yoshuawuyts a=yoshuawuyts Was talking in chat about futures timeouts, and apparently folks missed we had two different timeout functions. This links them to each other so if you find one, you also become aware of the other. Thanks! Co-authored-by: Yoshua Wuyts <yoshuawuyts@gmail.com> |
5 years ago | |
---|---|---|
benches | 5 years ago | |
ci | 5 years ago | |
docs | 5 years ago | |
examples | 5 years ago | |
src | 5 years ago | |
tests | 5 years ago | |
.gitignore | 5 years ago | |
.travis.yml | 5 years ago | |
CHANGELOG.md | 5 years ago | |
CODE_OF_CONDUCT.md | 5 years ago | |
Cargo.toml | 5 years ago | |
LICENSE-APACHE | 5 years ago | |
LICENSE-MIT | 5 years ago | |
README.md | 5 years ago | |
bors.toml | 5 years ago | |
rustfmt.toml | 5 years ago |
README.md
Async version of Rust's 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.
Documentation
async-std
comes with extensive API documentation and a book.
Quickstart
Add the following lines to your Cargo.toml
:
[dependencies]
async-std = "0.99"
Or use cargo add if you have it installed:
$ cargo add async-std
Hello world
use async_std::task;
fn main() {
task::block_on(async {
println!("Hello, world!");
})
}
Low-Friction Sockets with Built-In Timeouts
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)
}).await
}
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
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
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.