Struct RequestBuilder

pub struct RequestBuilder { /* private fields */ }

A Request builder.

You can use Request::builder to start an empty builder.

Implementations

impl RequestBuilder

pub fn new() -> Self

New default request builder.

pub fn method(self, method: impl TryMethod) -> Result<Self, Error>

Set the HTTP method for this request.

pub fn uri(self, uri: impl TryUri) -> Result<Self, Error>

Set the URI for this request.

pub fn header( self, name: impl TryHeaderName, value: impl TryHeaderValue, ) -> Result<Self, Error>

Appends a header to this request.

pub fn cookie_jar(self, cookie_jar: CookieJar) -> Self

Set a cookie jar to use to accept, store, and supply cookies for incoming responses and outgoing requests.

Note that the default_client already has a cookie jar.

pub fn timeout(self, timeout: Duration) -> Self

Specify a maximum amount of time that a complete request/response cycle is allowed to take before being aborted. This includes DNS resolution, connecting to the server, writing the request, and reading the response.

Note that this includes the response read operation, so if you get a response but don’t read-it within this timeout you will get a TimedOut IO error.

By default no timeout is used.

pub fn connect_timeout(self, timeout: Duration) -> Self

Set a timeout for establishing connections to a host.

If not set, the default_client default of 90 seconds will be used.

pub fn low_speed_timeout(self, low_speed: u32, timeout: Duration) -> Self

Specify a maximum amount of time where transfer rate can go below a minimum speed limit.

The low_speed limit is in bytes/s. No low-speed limit is configured by default.

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

Set a policy for automatically following server redirects.

If enabled the “Referer” header will be set automatically too.

The default_client follows up-to 20 redirects.

pub fn auto_decompress(self, enabled: bool) -> Self

Enable or disable automatic decompression of the response body.

If enabled the “Accept-Encoding” will also be set automatically, if it was not set using header.

This is enabled by default.

pub fn max_upload_speed(self, max: u64) -> Self

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

pub fn max_download_speed(self, max: u64) -> Self

Set a maximum download speed for the response body, in bytes per second.

pub fn max_length(self, max: ByteLength) -> Self

Set the maximum response content length allowed.

If the Content-Length is present on the response and it exceeds this limit an error is returned immediately, otherwise if require_length is not enabled an error will be returned only when the downloaded body length exceeds the limit.

No limit by default.

pub fn require_length(self, require: bool) -> Self

Set if the Content-Length header must be present in the response.

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

Enable or disable metrics collecting.

When enabled you can get the information using the Response::metrics method.

This is enabled by default.

pub fn build(self) -> Request

Build the request without a body.

pub fn body(self, body: impl TryBody) -> Result<Request, Error>

Build the request with a body.

pub fn build_custom<F>(self, custom: F) -> Result<Request, Error>

where F: FnOnce(Builder) -> Result<Request<AsyncBody>>,

Build the request with more custom build calls in the inner builder.

Trait Implementations

impl Debug for RequestBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RequestBuilder

fn default() -> Self

Returns the “default value” for a type.