Crate attohttpc

Expand description

This project’s goal is to provide a lightweight and simple HTTP client for the Rust ecosystem. The intended use is for projects that have HTTP needs where performance is not critical or when HTTP is not the main purpose of the application. Note that the project still tries to perform well and avoid allocation where possible, but stays away from Rust’s asynchronous stack to provide a crate that’s as small as possible. Features are provided behind feature flags when possible to allow users to get just what they need.

Check out the repository for more information and examples.

Quick start

let obj = json!({
    "hello": "world",
});

let resp = attohttpc::post("https://my-api.org/do/something")
    .header("X-My-Header", "foo")   // set a header for the request
    .param("qux", "baz")            // set a query parameter
    .json(&obj)?                    // set the request body (json feature required)
    .send()?;                       // send the request

// Check if the status is a 2XX code.
if resp.is_success() {
    // Consume the response body as text and print it.
    println!("{}", resp.text()?);
}

Features

charsets support for decoding more text encodings than just UTF-8
compress support for decompressing response bodies (default)
json support for serialization and deserialization
form support for url encoded forms (does not include support for multipart)
tls support for tls connections (default)
tls-rustls support for TLS connections using rustls instead of native-tls
multipart-form support for multipart forms (does not include support for url encoding)

Activating a feature

To activate a feature, specify it in your Cargo.toml file like so

attohttpc = { version = "...", features = ["json", "form", ...] }

Modules

body

Contains types to describe request bodies

header

This module is a re-export of the http crate’s header module.

Structs

Error

A type that contains all the errors that can possibly occur while accessing an HTTP server.

Method

The Request Method (VERB)

PreparedRequest

Represents a request that’s ready to be sent. You can inspect this object for information about the request.

ProxySettings

Contains proxy settings and utilities to find which proxy to use for a given URL.

ProxySettingsBuilder

Utility to build ProxySettings easily.

RequestBuilder

RequestBuilder is the main way of building requests.

RequestInspector

Allows to inspect the properties of a request before preparing it.

Response

Response represents a response returned by a server.

ResponseReader

The ResponseReader is used to read the body of a response.

Session

Session is a type that can carry settings over multiple requests. The settings applied to the Session are applied to every request created from this Session.

StatusCode

An HTTP status code (status-code in RFC 7230 et al.).