Struct attohttpc::RequestBuilder

source · [−]

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

Expand description

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

source

impl RequestBuilder

source

pub fn new(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.

source

pub fn try_new(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.

source

impl RequestBuilder

source

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.

source

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

source

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

Enable HTTP bearer authentication.

source

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.

source

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 carset to UTF-8.

source

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.

source

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.

source

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.

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.

source

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.

source

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.

source

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.

source

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.

source

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

Set the maximum number of redirections this request can perform.

The default is 5.

source

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

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

This value defaults to true.

source

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

Sets a connect timeout for this request.

The default is 30 seconds.

source

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

Sets a read timeout for this request.

The default is 30 seconds.

source

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

Sets a timeout for the whole request.

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

source

pub fn proxy_settings(self, 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.

source

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.

source

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.

source