Skip to content
Minimal request library in rust.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src fix warning in --no-default-features Mar 30, 2019
.gitignore initial commit Jun 10, 2018
Cargo.lock 0.9.1 Mar 30, 2019
Cargo.toml 0.9.1 Mar 30, 2019
README.md rustls instead of native-tls Dec 19, 2018

README.md

ureq

Minimal request library in rust.

Usage

// requires feature: `ureq = { version = "*", features = ["json"] }`
#[macro_use]
extern crate ureq;

fn main() {

    // sync post request of some json.
    let resp = ureq::post("https://myapi.acme.com/ingest")
        .set("X-My-Header", "Secret")
        .send_json(json!({
            "name": "martin",
            "rust": true
        }));

    // .ok() tells if response is 200-299.
    if resp.ok() {
        // ...
    }
}

Features

To enable a minimal dependency tree, some features are off by default. You can control them when including ureq as a dependency.

    ureq = { version = "*", features = ["json", "charset"] }
  • tls enables https. This is enabled by default.
  • json enables response.into_json() and request.send_json() serde json.
  • charset enables interpreting the charset part of Content-Type: text/plain; charset=iso-8859-1. Without this, the library defaults to rust's built in utf-8.

Motivation

  • Minimal dependency tree
  • Obvious API

This library tries to provide a convenient request library with a minimal dependency tree and an obvious API. It is inspired by libraries like superagent and fetch API.

Sync (for now)

This library uses blocking socket reads and writes, for now. The async story in rust is in heavy development and when used currently pulls in a heavy dependency tree (tokio etc). Once more async support is in rust core and won't drag those dependencies, this library might change.

TODO

  • Forms with application/x-www-form-urlencoded
  • multipart/form-data
  • Expect 100-continue
  • Use rustls when ring with versioned asm symbols is released. (PR is not resolved, but most implementations have settled on 0.13)

License (MIT)

Copyright (c) 2018 Martin Algesten

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.