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 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
use crate::{ auth::{Authentication, Credentials}, client::ResponseFuture, config::*, {Body, Error}, }; use http::{Request, Response}; use std::iter::FromIterator; use std::net::SocketAddr; use std::time::Duration; /// Provides additional methods when building a request for configuring various /// execution-related options on how the request should be sent. pub trait RequestBuilderExt { /// Set a maximum amount of time that the request is allowed to take before /// being aborted. /// /// If not set, no timeout will be enforced. /// /// # Examples /// /// ```no_run /// use isahc::prelude::*; /// use std::time::Duration; /// /// // This page is too slow and won't respond in time. /// let response = Request::get("https://httpbin.org/delay/10") /// .timeout(Duration::from_secs(5)) /// .body(())? /// .send() /// .expect_err("page should time out"); /// # Ok::<(), isahc::Error>(()) /// ``` fn timeout(&mut self, timeout: Duration) -> &mut Self; /// Set a timeout for the initial connection phase. /// /// If not set, a connect timeout of 300 seconds will be used. fn connect_timeout(&mut self, timeout: Duration) -> &mut Self; /// Configure how the use of HTTP versions should be negotiated with the /// server. /// /// The default is [`HttpVersionNegotiation::latest_compatible`]. fn version_negotiation(&mut self, negotiation: VersionNegotiation) -> &mut Self; /// Set a policy for automatically following server redirects. /// /// The default is to not follow redirects. /// /// # Examples /// /// ```no_run /// use isahc::config::RedirectPolicy; /// use isahc::prelude::*; /// /// // This URL redirects us to where we want to go. /// let response = Request::get("https://httpbin.org/redirect/1") /// .redirect_policy(RedirectPolicy::Follow) /// .body(())? /// .send()?; /// /// // This URL redirects too much! /// let error = Request::get("https://httpbin.org/redirect/10") /// .redirect_policy(RedirectPolicy::Limit(5)) /// .body(())? /// .send() /// .expect_err("too many redirects"); /// # Ok::<(), isahc::Error>(()) /// ``` fn redirect_policy(&mut self, policy: RedirectPolicy) -> &mut Self; /// Update the `Referer` header automatically when following redirects. fn auto_referer(&mut self) -> &mut Self; /// Set one or more HTTP authentication methods to attempt to use when /// authenticating with the server. /// /// Depending on the authentication schemes enabled, you will also need to /// set credentials to use for authentication using /// [`RequestBuilderExt::credentials`]. fn authentication(&mut self, authentication: Authentication) -> &mut Self; /// Set the credentials to use for HTTP authentication on this requests. /// /// This setting will do nothing unless you also set one or more /// authentication methods using [`RequestBuilderExt::authentication`]. fn credentials(&mut self, credentials: Credentials) -> &mut Self; /// Enable TCP keepalive with a given probe interval. fn tcp_keepalive(&mut self, interval: Duration) -> &mut Self; /// Enables the `TCP_NODELAY` option on connect. fn tcp_nodelay(&mut self) -> &mut Self; /// Set a proxy to use for the request. /// /// The proxy protocol is specified by the URI scheme. /// /// - **`http`**: Proxy. Default when no scheme is specified. /// - **`https`**: HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and /// NSS) /// - **`socks4`**: SOCKS4 Proxy. /// - **`socks4a`**: SOCKS4a Proxy. Proxy resolves URL hostname. /// - **`socks5`**: SOCKS5 Proxy. /// - **`socks5h`**: SOCKS5 Proxy. Proxy resolves URL hostname. /// /// By default no proxy will be used, unless one is specified in either the /// `http_proxy` or `https_proxy` environment variables. /// /// Setting to `None` explicitly disable the use of a proxy. fn proxy(&mut self, proxy: impl Into<Option<http::Uri>>) -> &mut Self; /// Disable proxy usage to use for the provided list of hosts. fn proxy_blacklist(&mut self, hosts: impl IntoIterator<Item = String>) -> &mut Self; /// Set one or more HTTP authentication methods to attempt to use when /// authenticating with a proxy. /// /// Depending on the authentication schemes enabled, you will also need to /// set credentials to use for authentication using /// [`RequestBuilderExt::proxy_credentials`]. fn proxy_authentication(&mut self, authentication: Authentication) -> &mut Self; /// Set the credentials to use for proxy authentication. /// /// This setting will do nothing unless you also set one or more proxy /// authentication methods using /// [`RequestBuilderExt::proxy_authentication`]. fn proxy_credentials(&mut self, credentials: Credentials) -> &mut Self; /// Set a maximum upload speed for the request body, in bytes per second. /// /// The default is unlimited. fn max_upload_speed(&mut self, max: u64) -> &mut Self; /// Set a maximum download speed for the response body, in bytes per second. /// /// The default is unlimited. fn max_download_speed(&mut self, max: u64) -> &mut Self; /// Set a list of specific DNS servers to be used for DNS resolution. /// /// By default this option is not set and the system's built-in DNS resolver /// is used. This option can only be used if libcurl is compiled with /// [c-ares](https://c-ares.haxx.se), otherwise this option has no effect. fn dns_servers(&mut self, servers: impl IntoIterator<Item = SocketAddr>) -> &mut Self; /// Set a custom SSL/TLS client certificate to use for all client /// connections. /// /// If a format is not supported by the underlying SSL/TLS engine, an error /// will be returned when attempting to send a request using the offending /// certificate. /// /// The default value is none. /// /// # Examples /// /// ```no_run /// use isahc::config::{ClientCertificate, PrivateKey}; /// use isahc::prelude::*; /// /// let response = Request::get("localhost:3999") /// .ssl_client_certificate(ClientCertificate::pem_file( /// "client.pem", /// PrivateKey::pem_file("key.pem", String::from("secret")), /// )) /// .body(())? /// .send()?; /// # Ok::<(), isahc::Error>(()) /// ``` fn ssl_client_certificate(&mut self, certificate: ClientCertificate) -> &mut Self; /// Set a custom SSL/TLS CA certificate bundle to use. /// /// The default value is none. fn ssl_ca_certificate(&mut self, certificate: CaCertificate) -> &mut Self; /// Set a list of ciphers to use for SSL/TLS connections. /// /// The list of valid cipher names is dependent on the underlying SSL/TLS /// engine in use. You can find an up-to-date list of potential cipher names /// at <https://curl.haxx.se/docs/ssl-ciphers.html>. /// /// The default is unset and will result in the system defaults being used. fn ssl_ciphers(&mut self, servers: impl IntoIterator<Item = String>) -> &mut Self; /// Set various options for this request that control SSL/TLS behavior. /// /// Most options are for disabling security checks that introduce security /// risks, but may be required as a last resort. Note that the most secure /// options are already the default and do not need to be specified. /// /// The default value is [`SslOption::NONE`]. /// /// # Warning /// /// You should think very carefully before using this method. Using *any* /// options that alter how certificates are validated can introduce /// significant security vulnerabilities. /// /// # Examples /// /// ``` /// # use isahc::config::*; /// # use isahc::prelude::*; /// # /// let response = Request::get("https://badssl.com") /// .ssl_options(SslOption::DANGER_ACCEPT_INVALID_CERTS | SslOption::DANGER_ACCEPT_REVOKED_CERTS) /// .body(())? /// .send()?; /// # Ok::<(), isahc::Error>(()) /// ``` fn ssl_options(&mut self, options: SslOption) -> &mut Self; /// Enable or disable comprehensive metrics collection for this request. /// /// See [`HttpClientBuilder::metrics`](crate::HttpClientBuilder::metrics) /// for details. fn metrics(&mut self, enable: bool) -> &mut Self; } impl RequestBuilderExt for http::request::Builder { fn timeout(&mut self, timeout: Duration) -> &mut Self { self.extension(Timeout(timeout)) } fn connect_timeout(&mut self, timeout: Duration) -> &mut Self { self.extension(ConnectTimeout(timeout)) } fn version_negotiation(&mut self, negotiation: VersionNegotiation) -> &mut Self { self.extension(negotiation) } fn redirect_policy(&mut self, policy: RedirectPolicy) -> &mut Self { self.extension(policy) } fn auto_referer(&mut self) -> &mut Self { self.extension(AutoReferer) } fn authentication(&mut self, authentication: Authentication) -> &mut Self { self.extension(authentication) } fn credentials(&mut self, credentials: Credentials) -> &mut Self { self.extension(credentials) } fn tcp_keepalive(&mut self, interval: Duration) -> &mut Self { self.extension(TcpKeepAlive(interval)) } fn tcp_nodelay(&mut self) -> &mut Self { self.extension(TcpNoDelay) } fn proxy(&mut self, proxy: impl Into<Option<http::Uri>>) -> &mut Self { self.extension(Proxy(proxy.into())) } fn proxy_blacklist(&mut self, hosts: impl IntoIterator<Item = String>) -> &mut Self { self.extension(ProxyBlacklist::from_iter(hosts)) } fn proxy_authentication(&mut self, authentication: Authentication) -> &mut Self { self.extension(Proxy(authentication)) } fn proxy_credentials(&mut self, credentials: Credentials) -> &mut Self { self.extension(Proxy(credentials)) } fn max_upload_speed(&mut self, max: u64) -> &mut Self { self.extension(MaxUploadSpeed(max)) } fn max_download_speed(&mut self, max: u64) -> &mut Self { self.extension(MaxDownloadSpeed(max)) } fn dns_servers(&mut self, servers: impl IntoIterator<Item = SocketAddr>) -> &mut Self { self.extension(dns::Servers::from_iter(servers)) } fn ssl_ciphers(&mut self, servers: impl IntoIterator<Item = String>) -> &mut Self { self.extension(ssl::Ciphers::from_iter(servers)) } fn ssl_client_certificate(&mut self, certificate: ClientCertificate) -> &mut Self { self.extension(certificate) } fn ssl_ca_certificate(&mut self, certificate: CaCertificate) -> &mut Self { self.extension(certificate) } fn ssl_options(&mut self, options: SslOption) -> &mut Self { self.extension(options) } fn metrics(&mut self, enable: bool) -> &mut Self { self.extension(EnableMetrics(enable)) } } /// Extension methods on an HTTP request. pub trait RequestExt<T> { /// Send the HTTP request synchronously using the default client. /// /// This is a convenience method that is equivalent to /// [`send`](crate::send). /// /// # Examples /// /// ```no_run /// use isahc::prelude::*; /// /// let response = Request::post("https://httpbin.org/post") /// .header("Content-Type", "application/json") /// .body(r#"{ /// "speed": "fast", /// "cool_name": true /// }"#)? /// .send()?; /// # Ok::<(), isahc::Error>(()) /// ``` fn send(self) -> Result<Response<Body>, Error> where T: Into<Body>; /// Sends the HTTP request asynchronously using the default client. /// /// This is a convenience method that is equivalent to /// [`send_async`](crate::send_async). fn send_async(self) -> ResponseFuture<'static> where T: Into<Body>; } impl<T> RequestExt<T> for Request<T> { fn send(self) -> Result<Response<Body>, Error> where T: Into<Body>, { crate::send(self) } fn send_async(self) -> ResponseFuture<'static> where T: Into<Body>, { crate::send_async(self) } }