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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
//! The practical HTTP client that is fun to use. //! //! Here are some of cHTTP's key features: //! //! - Full support for HTTP/1.1 and HTTP/2. //! - Configurable request timeouts. //! - Fully asynchronous core, with asynchronous and incremental reading and //! writing of request and response bodies. //! - Offers an ergonomic synchronous API as well as an asynchronous API with //! support for async/await. //! - Optional automatic redirect following. //! - Sessions and cookie persistence. //! //! # Getting started //! //! Sending requests is as easy as calling a single function. Let's make a //! simple GET request to an example website: //! //! ```no_run //! use chttp::prelude::*; //! //! let mut response = chttp::get("https://example.org")?; //! println!("{}", response.text()?); //! # Ok::<(), chttp::Error>(()) //! ``` //! //! By default, sending a request will wait for the response, up until the //! response headers are received. The returned response struct includes the //! response body as an open stream implementing [`Read`](std::io::Read). //! //! Sending a POST request is also easy, and takes an additional argument for //! the request body: //! //! ```no_run //! let response = chttp::post("https://httpbin.org/post", "make me a salad")?; //! # Ok::<(), chttp::Error>(()) //! ``` //! //! cHTTP provides several other simple functions for common HTTP request types: //! //! ```no_run //! chttp::put("https://httpbin.org/put", "have a salad")?; //! chttp::head("https://httpbin.org/get")?; //! chttp::delete("https://httpbin.org/delete")?; //! # Ok::<(), chttp::Error>(()) //! ``` //! //! If you want to customize the request by adding headers, setting timeouts, //! etc, then you can create a [`Request`][prelude::Request] using a //! builder-style fluent interface, then finishing it off with a //! [`send`][RequestExt::send]: //! //! ```no_run //! use chttp::prelude::*; //! use std::time::Duration; //! //! let response = Request::post("https://httpbin.org/post") //! .header("Content-Type", "application/json") //! .timeout(Duration::from_secs(5)) //! .body(r#"{ //! "speed": "fast", //! "cool_name": true //! }"#)? //! .send()?; //! # Ok::<(), chttp::Error>(()) //! ``` //! //! Check out the [examples] directory in the project sources for even more //! examples. //! //! # Feature tour //! //! Below is a brief overview of some notable features of cHTTP. Check out the //! rest of the documentation for even more guides and examples. //! //! ## Easy request functions //! //! You can start sending requests without any configuration by using the global //! functions in this module, including [`get`], [`post`], and [`send`]. These //! use a shared HTTP client instance with sane defaults, so it is easy to get //! up and running. They should work perfectly fine for many use-cases, so don't //! about graduating to more complex APIs if you don't need them. //! //! ## Request and response traits //! //! cHTTP includes a number of traits in the [`prelude`] module that extend the //! [`Request`] and [`Response`] types with a plethora of extra methods that //! make common tasks convenient and allow you to make more advanced //! configuration. //! //! Some key traits to read about include [`RequestExt`], [`RequestBuilderExt`], //! and [`ResponseExt`]. //! //! ## Custom clients //! //! The free-standing functions for sending requests use a shared [`HttpClient`] //! instance, but you can also create your own client instances, which allows //! you to customize the default behavior for requests that use it. //! //! See the documentation for [`HttpClient`] and [`HttpClientBuilder`] for more //! information on creating custom clients. //! //! ## Asynchronous requests //! //! Requests are always executed asynchronously under the hood. This allows a //! single client to execute a large number of requests concurrently with //! minimal overhead. //! //! If you are writing an asynchronous application, you can additionally benefit //! from the async nature of the client by using the asynchronous methods //! available to prevent blocking threads in your code. All request methods have //! an asynchronous variant that ends with `_async` in the name. Here is our //! first example rewritten to use async/await syntax (nightly Rust only): //! //! ```ignore //! use chttp::prelude::*; //! //! let mut response = chttp::get_async("https://httpbin.org/get").await?; //! println!("{}", response.text_async().await?); //! ``` //! //! # Logging //! //! cHTTP logs quite a bit of useful information at various levels using the //! [log] crate. //! //! If you set the log level to `Trace` for the `chttp::wire` target, cHTTP will //! also log all incoming and outgoing data while in flight. This may come in //! handy if you are debugging code and need to see the exact data being sent to //! the server and being received. //! //! [examples]: https://github.com/sagebind/chttp/tree/master/examples //! [log]: https://docs.rs/log #![deny(unsafe_code)] #![warn( future_incompatible, missing_debug_implementations, missing_docs, rust_2018_idioms, unreachable_pub, unused, clippy::all, )] use http::{Request, Response}; use lazy_static::lazy_static; #[cfg(feature = "cookies")] pub mod cookies; #[cfg(feature = "middleware-api")] pub mod middleware; #[cfg(not(feature = "middleware-api"))] #[allow(unreachable_pub, unused)] mod middleware; mod agent; mod body; mod client; pub mod config; mod error; mod handler; mod io; mod parse; mod request; mod response; mod task; pub use crate::{ body::Body, client::{HttpClient, HttpClientBuilder, ResponseFuture}, error::Error, request::{RequestBuilderExt, RequestExt}, response::ResponseExt, }; /// Re-export of the standard HTTP types. pub use http; /// A "prelude" for importing common cHTTP types. pub mod prelude { pub use crate::{ Body, HttpClient, RequestExt, RequestBuilderExt, ResponseExt, }; pub use http::{Request, Response}; } /// Send a GET request to the given URI. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::get`] for details. pub fn get<U>(uri: U) -> Result<Response<Body>, Error> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().get(uri) } /// Send a GET request to the given URI asynchronously. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::get_async`] for details. pub fn get_async<U>(uri: U) -> ResponseFuture<'static> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().get_async(uri) } /// Send a HEAD request to the given URI. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::head`] for details. pub fn head<U>(uri: U) -> Result<Response<Body>, Error> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().head(uri) } /// Send a HEAD request to the given URI asynchronously. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::head_async`] for details. pub fn head_async<U>(uri: U) -> ResponseFuture<'static> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().head_async(uri) } /// Send a POST request to the given URI with a given request body. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::post`] for details. pub fn post<U>(uri: U, body: impl Into<Body>) -> Result<Response<Body>, Error> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().post(uri, body) } /// Send a POST request to the given URI asynchronously with a given request /// body. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::post_async`] for details. pub fn post_async<U>(uri: U, body: impl Into<Body>) -> ResponseFuture<'static> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().post_async(uri, body) } /// Send a PUT request to the given URI with a given request body. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::put`] for details. pub fn put<U>(uri: U, body: impl Into<Body>) -> Result<Response<Body>, Error> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().put(uri, body) } /// Send a PUT request to the given URI asynchronously with a given request /// body. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::put_async`] for details. pub fn put_async<U>(uri: U, body: impl Into<Body>) -> ResponseFuture<'static> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().put_async(uri, body) } /// Send a DELETE request to the given URI. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::delete`] for details. pub fn delete<U>(uri: U) -> Result<Response<Body>, Error> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().delete(uri) } /// Send a DELETE request to the given URI asynchronously. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::delete_async`] for details. pub fn delete_async<U>(uri: U) -> ResponseFuture<'static> where http::Uri: http::HttpTryFrom<U>, { HttpClient::shared().delete_async(uri) } /// Send an HTTP request and return the HTTP response. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::send`] for details. pub fn send<B: Into<Body>>(request: Request<B>) -> Result<Response<Body>, Error> { HttpClient::shared().send(request) } /// Send an HTTP request and return the HTTP response asynchronously. /// /// The request is executed using a shared [`HttpClient`] instance. See /// [`HttpClient::send_async`] for details. pub fn send_async<B: Into<Body>>(request: Request<B>) -> ResponseFuture<'static> { HttpClient::shared().send_async(request) } /// Gets a human-readable string with the version number of cHTTP and its /// dependencies. /// /// This function can be helpful when troubleshooting issues in cHTTP or one of /// its dependencies. pub fn version() -> &'static str { static FEATURES_STRING: &str = include_str!(concat!(env!("OUT_DIR"), "/features.txt")); lazy_static! { static ref VERSION_STRING: String = format!( "chttp/{} (features:{}) {}", env!("CARGO_PKG_VERSION"), FEATURES_STRING, curl::Version::num(), ); } &VERSION_STRING }