1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
#![deny(warnings)] #![deny(missing_docs)] //! # reqwest //! //! The `reqwest` crate provides a convenient, higher-level HTTP Client. //! //! It handles many of the things that most people just expect an HTTP client //! to do for them. //! //! - Uses system-native TLS //! - Plain bodies, JSON, urlencoded, (TODO: multipart) //! - Customizable redirect policy //! - (TODO: Cookies) //! //! The `reqwest::Client` is synchronous, making it a great fit for //! applications that only require a few HTTP requests, and wish to handle //! them synchronously. When [hyper][] releases with asynchronous support, //! `reqwest` will be updated to use it internally, but still provide a //! synchronous Client, for convenience. A `reqwest::async::Client` will also //! be added. //! //! ## Making a GET request //! //! For a single request, you can use the [`get`][get] shortcut method. //! //! ```no_run //! use std::io::Read; //! let mut resp = reqwest::get("https://www.rust-lang.org").unwrap(); //! assert!(resp.status().is_success()); //! //! let mut content = String::new(); //! resp.read_to_string(&mut content); //! ``` //! //! As you can see, reqwest's [`Response`][response] struct implements Rust's //! `Read` trait, so many useful standard library and third party crates will //! have convenience methods that take a `Response` anywhere `T: Read` is //! acceptable. //! //! If you plan to perform multiple requests, it is best to create a [`Client`][client] //! and reuse it, taking advantage of keep-alive connection pooling. //! //! ## Making POST requests (or setting request bodies) //! //! There are several ways you can set the body of a request. The basic one is //! by using the `body()` method of a [`RequestBuilder`][builder]. This lets you set the //! exact raw bytes of what the body should be. It accepts various types, //! including `String`, `Vec<u8>`, and `File`. If you wish to pass a custom //! Reader, you can use the `reqwest::Body::new()` constructor. //! //! ```no_run //! let client = reqwest::Client::new().unwrap(); //! let res = client.post("http://httpbin.org/post") //! .body("the exact body that is sent") //! .send(); //! ``` //! //! ### Forms //! //! It's very common to want to send form data in a request body. This can be //! done with any type that can be serialized into form data. //! //! This can be an array of tuples, or a `HashMap`, or a custom type that //! implements [`Serialize`][serde]. //! //! ```no_run //! // This will POST a body of `foo=bar&baz=quux` //! let params = [("foo", "bar"), ("baz", "quux")]; //! let client = reqwest::Client::new().unwrap(); //! let res = client.post("http://httpbin.org/post") //! .form(¶ms) //! .send(); //! ``` //! //! ### JSON //! //! There is also a `json` method helper on the [`RequestBuilder`][builder] that works in //! a similar fashion the `form` method. It can take any value that can be //! serialized into JSON. //! //! ```no_run //! # use std::collections::HashMap; //! // This will POST a body of `{"lang":"rust","body":"json"}` //! let mut map = HashMap::new(); //! map.insert("lang", "rust"); //! map.insert("body", "json"); //! //! let client = reqwest::Client::new().unwrap(); //! let res = client.post("http://httpbin.org/post") //! .json(&map) //! .send(); //! ``` //! //! [hyper]: http://hyper.rs //! [client]: ./struct.Client.html //! [response]: ./struct.Response.html //! [get]: ./fn.get.html //! [builder]: ./client/struct.RequestBuilder.html //! [serde]: http://serde.rs extern crate hyper; #[macro_use] extern crate log; extern crate libflate; extern crate hyper_native_tls; extern crate serde; extern crate serde_json; extern crate serde_urlencoded; extern crate url; pub use hyper::client::IntoUrl; pub use hyper::Error as HyperError; pub use hyper::header; pub use hyper::mime; pub use hyper::method::Method; pub use hyper::status::StatusCode; pub use hyper::version::HttpVersion; pub use hyper::Url; pub use url::ParseError as UrlError; pub use self::client::{Client, RequestBuilder}; pub use self::error::{Error, Result}; pub use self::body::Body; pub use self::redirect::RedirectPolicy; pub use self::response::Response; mod body; mod client; mod error; mod redirect; mod response; /// Shortcut method to quickly make a `GET` request. /// /// See also the methods on the [`reqwest::Response`](./struct.Response.html) /// type. /// /// # Examples /// /// ```no_run /// use std::io::Read; /// /// let mut result = String::new(); /// reqwest::get("https://www.rust-lang.org").unwrap() /// .read_to_string(&mut result); /// ``` pub fn get<T: IntoUrl>(url: T) -> ::Result<Response> { let client = try!(Client::new()); client.get(url).send() } fn _assert_impls() { fn assert_send<T: Send>() {} fn assert_sync<T: Sync>() {} fn assert_clone<T: Clone>() {} assert_send::<Client>(); assert_sync::<Client>(); assert_clone::<Client>(); assert_send::<RequestBuilder>(); assert_send::<Response>(); }