Crate yukikaze

雪風(Yukikaze)

Beautiful and elegant Yukikaze is little HTTP client library based on hyper.

Available features

• flate2-c - Enables decompression using flate2 crate with C backend. Default on.
• flate2-rust - Enables decompression using flate2 crate with Rust backend. Default off.
• encoding - Enables encoding crate support. Default off.
• rt-tokio - Enables tokio runtime module. Default off.
• rt-tokio-multi - Enables multi-threaded tokio runtime. Overrides rt-tokio. Default off.
• rt-client - Enables Yukikaze client runtime module. Default off.
• rt - Enables rt-tokio and rt-client. Default off.
• websocket - Enables Websocket Upgrade mechanism. Default off. Enables carry_extensions when on.
• carry_extensions - Carries http::Extensions from request to resolved Response. Default off.

Features

• Uses rustls for TLS
• Support of various types of bodies: Plain text, JSON, multipart and forms
• Simple redirect policy with option to limit number of redirections.
• Support for encodings aside from UTF-8.
• Various helpers to extract useful headers: Cookies, ETag/Last-Modified, Content related headers.
• File redirection support for response's body.
• Notify interface to indicate progress of body's download.

Usage

In order to use Yukikaze-sama you need to create Client.

Configuration of of client can be defined using trait parameter Config. But default configuration in most cases reasonable for simple requests.

But if you need to work with client in generic context you can use its trait HttpClient.

Making request

Request builder provides rich set of methods to configure it, but in simple terms making request boils down to following code:

extern crate yukikaze;
extern crate tokio;

use yukikaze::client::{Client, HttpClient, Request};

fn main() {
    let mut tokio_rt = tokio::runtime::current_thread::Runtime::new().expect("To create runtime");
    let client = Client::default();

    let request = Request::get("http://127.0.0.1").expect("To create get request").empty();

    let response = client.execute(request); //Creates future response
    let response = tokio_rt.block_on(response); //Waits for response

    println!("response={:?}", response);
}

You can use rt module to simplify your workflow though.

Examples

• fie - CLI shit posting tool for various social medias.

Re-exports

pub extern crate serde;

pub extern crate serde_json;

pub extern crate serde_urlencoded;

pub extern crate cookie2;

pub extern crate percent_encoding;

pub extern crate http;

pub extern crate httpdate;

pub extern crate mime;

pub extern crate etag;

pub extern crate tokio;

pub extern crate tokio_timer;

pub extern crate hyper;

pub extern crate futures;

pub extern crate data_encoding;

pub extern crate bytes;

pub extern crate flate2;

pub extern crate encoding_rs;

pub use cookie2 as cookie;

Modules

client	Client module
header	Headers module
rt	Runtime module