Adding `areq` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add areq

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

areq = "0.1.0-alpha5"

The areq library will be automatically available globally. Read the areq library documentation.

Back to the crate overview.

Readme

areq

Async runtime agnostic HTTP requests

Development

🚧 The library is currently under development 🚧

Many features require an unstable Rust feature – return type notation. The main crate areq has the rtn feature, which enables the missing functionality. High-level crates areq-smol and areq-tokio require this feature for compilation, so to use the library you need to install nightly compiler. Once the RTN feature is stabilized, the library will be usable on stable.

Features

Async only, no hidden overhead from blocking API
Independent of any async runtime, including features. Instead, the runtime extends the functionality of the base crate
Zero-cost abstractions for a flexible solution and an ability to choose a simple API when needed
Modular and configurable – build exactly the HTTP client you need

Getting Started

Although the library is runtime-agnostic, it also provides high-level crates for choosing a specific runtime. Currently, two crates are available:

areq-smol provides support for the smol runtime
areq-tokio provides support for the tokio runtime

As an example, let's use tokio and add the crate to a project. You also need to select an HTTP protocol version that the client will support. For this example, let's use HTTP/1.1 which can be enabled with the http1 cargo feature:

cargo add areq-tokio -F http1

Now you can make a GET request and read a response body:

use {
    areq_tokio::{areq::{http::Uri, http1::Http1}, prelude::*},
    std::io::Error,
};

async fn get() -> Result<String, Error> {
    let uri = Uri::from_static("http://127.0.0.1:3001/hello");
    let (mut client, conn) = Http1::default().connect(&uri).await?;
    tokio::spawn(conn);

    client.get(uri, ()).await?.text().await
}

fn main() {
    let rt = tokio::runtime::Runtime::new();
    match rt.and_then(|rt| rt.block_on(get())) {
        Ok(text) => println!("{text}"),
        Err(e) => eprintln!("io error: {e}"),
    }
}

Adding areq library as a dependency

Adding `areq` library as a dependency