[−][src]Trait isahc::prelude::RequestBuilderExt

pub trait RequestBuilderExt {
    fn timeout(&mut self, timeout: Duration) -> &mut Self;

    fn connect_timeout(&mut self, timeout: Duration) -> &mut Self;

    fn version_negotiation(
        &mut self, 
        negotiation: VersionNegotiation
    ) -> &mut Self;

    fn redirect_policy(&mut self, policy: RedirectPolicy) -> &mut Self;

    fn auto_referer(&mut self) -> &mut Self;

    fn authentication(&mut self, authentication: Authentication) -> &mut Self;

    fn credentials(&mut self, credentials: Credentials) -> &mut Self;

    fn tcp_keepalive(&mut self, interval: Duration) -> &mut Self;

    fn tcp_nodelay(&mut self) -> &mut Self;

    fn proxy(&mut self, proxy: impl Into<Option<Uri>>) -> &mut Self;

    fn proxy_blacklist(
        &mut self, 
        hosts: impl IntoIterator<Item = String>
    ) -> &mut Self;

    fn proxy_authentication(
        &mut self, 
        authentication: Authentication
    ) -> &mut Self;

    fn proxy_credentials(&mut self, credentials: Credentials) -> &mut Self;

    fn max_upload_speed(&mut self, max: u64) -> &mut Self;

    fn max_download_speed(&mut self, max: u64) -> &mut Self;

    fn dns_servers(
        &mut self, 
        servers: impl IntoIterator<Item = SocketAddr>
    ) -> &mut Self;

    fn ssl_client_certificate(
        &mut self, 
        certificate: ClientCertificate
    ) -> &mut Self;

    fn ssl_ca_certificate(&mut self, certificate: CaCertificate) -> &mut Self;

    fn ssl_ciphers(
        &mut self, 
        servers: impl IntoIterator<Item = String>
    ) -> &mut Self;

    fn ssl_options(&mut self, options: SslOption) -> &mut Self;

    fn metrics(&mut self, enable: bool) -> &mut Self;
}

Provides additional methods when building a request for configuring various execution-related options on how the request should be sent.

Required methods

fn timeout(&mut self, timeout: Duration) -> &mut Self

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

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");

fn connect_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 version_negotiation(&mut self, negotiation: VersionNegotiation) -> &mut Self

Configure how the use of HTTP versions should be negotiated with the server.

The default is [HttpVersionNegotiation::latest_compatible].

fn redirect_policy(&mut self, policy: RedirectPolicy) -> &mut Self

Set a policy for automatically following server redirects.

The default is to not follow redirects.

Examples

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");

fn auto_referer(&mut self) -> &mut Self

Update the Referer header automatically when following redirects.

fn authentication(&mut self, authentication: Authentication) -> &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 credentials(&mut self, credentials: Credentials) -> &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 tcp_keepalive(&mut self, interval: Duration) -> &mut Self

Enable TCP keepalive with a given probe interval.

fn tcp_nodelay(&mut self) -> &mut Self

Enables the TCP_NODELAY option on connect.

fn proxy(&mut self, proxy: impl Into<Option<Uri>>) -> &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_blacklist(
    &mut self,
    hosts: impl IntoIterator<Item = String>
) -> &mut Self

Disable proxy usage to use for the provided list of hosts.

fn proxy_authentication(&mut self, authentication: Authentication) -> &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_credentials(&mut self, credentials: Credentials) -> &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 max_upload_speed(&mut self, max: u64) -> &mut Self

Set a maximum upload speed for the request body, in bytes per second.

The default is unlimited.

fn max_download_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 dns_servers(
    &mut self,
    servers: impl IntoIterator<Item = SocketAddr>
) -> &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, otherwise this option has no effect.

fn ssl_client_certificate(
    &mut self,
    certificate: ClientCertificate
) -> &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

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()?;

fn ssl_ca_certificate(&mut self, certificate: CaCertificate) -> &mut Self

Set a custom SSL/TLS CA certificate bundle to use.

The default value is none.

fn ssl_ciphers(
    &mut self,
    servers: impl IntoIterator<Item = String>
) -> &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_options(&mut self, options: SslOption) -> &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

let response = Request::get("https://badssl.com")
    .ssl_options(SslOption::DANGER_ACCEPT_INVALID_CERTS | SslOption::DANGER_ACCEPT_REVOKED_CERTS)
    .body(())?
    .send()?;

fn metrics(&mut self, enable: bool) -> &mut Self

Enable or disable comprehensive metrics collection for this request.

See HttpClientBuilder::metrics for details.

Loading content...

Implementations on Foreign Types

impl RequestBuilderExt for Builder[src]

Loading content...

Implementors

Loading content...