Struct RequestBuilder

pub struct RequestBuilder<B = Empty> { /* private fields */ }

RequestBuilder is the main way of building requests.

You can create a RequestBuilder using the new or try_new method, but the recommended way or use one of the simpler constructors available in the crate root or on the Session struct, such as get, post, etc.

Implementations

impl RequestBuilder

pub fn new<U>(method: Method, base_url: U) -> Self

where U: AsRef<str>,

Create a new RequestBuilder with the base URL and the given method.

Panics

Panics if the base url is invalid or if the method is CONNECT.

pub fn try_new<U>(method: Method, base_url: U) -> Result<Self>

where U: AsRef<str>,

Try to create a new RequestBuilder.

If the base URL is invalid, an error is returned. If the method is CONNECT, an error is also returned. CONNECT is not yet supported.

impl<B> RequestBuilder<B>

pub fn param<K, V>(self, key: K, value: V) -> Self

where K: AsRef<str>, V: ToString,

Associate a query string parameter to the given value.

The same key can be used multiple times.

pub fn params<P, K, V>(self, pairs: P) -> Self

where P: IntoIterator, P::Item: Borrow<(K, V)>, K: AsRef<str>, V: ToString,

Associated a list of pairs to query parameters.

The same key can be used multiple times.

Example

attohttpc::get("http://foo.bar").params(&[("p1", "v1"), ("p2", "v2")]);

pub fn query<T: Serialize>(self, value: &T) -> Result<Self>

Set the query parameters of this request to be the URL-encoded representation of the given object.

pub fn basic_auth( self, username: impl Display, password: Option<impl Display>, ) -> Self

Enable HTTP basic authentication.

pub fn bearer_auth(self, token: impl Into<String>) -> Self

Enable HTTP bearer authentication.

pub fn body<B1: Body>(self, body: B1) -> RequestBuilder<B1>

Set the body of this request.

The BodyKind enum and Body trait determine how to implement custom request body types.

pub fn text<B1: AsRef<str>>(self, body: B1) -> RequestBuilder<Text<B1>>

Set the body of this request to be text.

If the Content-Type header is unset, it will be set to text/plain and the charset to UTF-8.

pub fn bytes<B1: AsRef<[u8]>>(self, body: B1) -> RequestBuilder<Bytes<B1>>

Set the body of this request to be bytes.

If the Content-Type header is unset, it will be set to application/octet-stream.

pub fn file(self, body: File) -> RequestBuilder<File>

Set the body of this request using a local file.

If the Content-Type header is unset, it will be set to application/octet-stream.

pub fn json<T: Serialize>( self, value: &T, ) -> Result<RequestBuilder<Bytes<Vec<u8>>>>

Set the body of this request to be the JSON representation of the given object.

If the Content-Type header is unset, it will be set to application/json and the charset to UTF-8.

pub fn json_streaming<T: Serialize>(self, value: T) -> RequestBuilder<Json<T>>

Set the body of this request to stream out a JSON representation of the given object.

If the Content-Type header is unset, it will be set to application/json and the charset to UTF-8.

pub fn form<T: Serialize>( self, value: &T, ) -> Result<RequestBuilder<Bytes<Vec<u8>>>>

Set the body of this request to be the URL-encoded representation of the given object.

If the Content-Type header is unset, it will be set to application/x-www-form-urlencoded.

pub fn headers(&self) -> &HeaderMap

Get a mutable reference to headers.

pub fn headers_mut(&mut self) -> &mut HeaderMap

Get a mutable reference to headers.

pub fn header<H, V>(self, header: H, value: V) -> Self

where H: IntoHeaderName, V: TryInto<HeaderValue>, Error: From<V::Error>,

Modify a header for this request.

If the header is already present, the value will be replaced. If you wish to append a new header, use header_append.

Panics

This method will panic if the value is invalid.

pub fn header_append<H, V>(self, header: H, value: V) -> Self

where H: IntoHeaderName, V: TryInto<HeaderValue>, Error: From<V::Error>,

Append a new header for this request.

The new header is always appended to the request, even if the header already exists.

Panics

This method will panic if the value is invalid.

pub fn try_header<H, V>(self, header: H, value: V) -> Result<Self>

where H: IntoHeaderName, V: TryInto<HeaderValue>, Error: From<V::Error>,

Modify a header for this request.

If the header is already present, the value will be replaced. If you wish to append a new header, use header_append.

pub fn try_header_append<H, V>(self, header: H, value: V) -> Result<Self>

where H: IntoHeaderName, V: TryInto<HeaderValue>, Error: From<V::Error>,

Append a new header to this request.

The new header is always appended to the request, even if the header already exists.

pub fn max_headers(self, max_headers: usize) -> Self

Set the maximum number of headers accepted in responses to this request.

The default is 100.

pub fn max_redirections(self, max_redirections: u32) -> Self

Set the maximum number of redirections this request can perform.

The default is 5.

pub fn follow_redirects(self, follow_redirects: bool) -> Self

Sets if this request should follow redirects, 3xx codes.

This value defaults to true.

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

Sets a connect timeout for this request.

The default is 30 seconds.

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

Sets a read timeout for this request.

The default is 30 seconds.

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

Sets a timeout for the whole request.

Applies after a TCP connection is established. Defaults to no timeout.

pub fn proxy_settings(self, proxy_settings: ProxySettings) -> Self

Sets the proxy settigns for this request.

If left untouched, the defaults are to use system proxy settings found in environment variables.

pub fn default_charset(self, default_charset: Option<Charset>) -> Self

Set the default charset to use while parsing the response of this request.

If the response does not say which charset it uses, this charset will be used to decode the request. This value defaults to None, in which case ISO-8859-1 is used.

pub fn allow_compression(self, allow_compression: bool) -> Self

Sets if this request will announce that it accepts compression.

This value defaults to true. Note that this only lets the browser know that this request supports compression, the server might choose not to compress the content.

pub fn danger_accept_invalid_certs(self, accept_invalid_certs: bool) -> Self

Sets if this request will accept invalid TLS certificates.

Accepting invalid certificates implies that invalid hostnames are accepted as well.

The default value is false.

Danger

Use this setting with care. This will accept any TLS certificate valid or not. If you are using self signed certificates, it is much safer to add their root CA to the list of trusted root CAs by your system.

pub fn danger_accept_invalid_hostnames( self, accept_invalid_hostnames: bool, ) -> Self

Sets if this request will accept an invalid hostname in a TLS certificate.

The default value is false.

Danger

Use this setting with care. This will accept TLS certificates that do not match the hostname.

pub fn add_root_certificate(self, cert: Certificate) -> Self

Adds a root certificate that will be trusted.

impl<B: Body> RequestBuilder<B>

pub fn prepare(self) -> PreparedRequest<B>

Create a PreparedRequest from this RequestBuilder.

Panics

Will panic if an error occurs trying to prepare the request. It shouldn’t happen.

pub fn try_prepare(self) -> Result<PreparedRequest<B>>

Create a PreparedRequest from this RequestBuilder.

pub fn send(self) -> Result<Response>

Send this request directly.

impl<B> RequestBuilder<B>

pub fn inspect(&mut self) -> RequestInspector<'_, B>

Inspect the properties of this request

Trait Implementations

impl<B: Debug> Debug for RequestBuilder<B>

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

Formats the value using the given formatter.