Struct attohttpc::RequestBuilder

pub struct RequestBuilder<B = [u8; 0]> { /* fields omitted */ }

Request is the main way of performing requests.

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

Methods

impl RequestBuilder

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

Create a new Request 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<V>(self, key: &str, value: V) -> Self where
    V: Display, 

Associate a query string parameter to the given value.

The same key can be used multiple times.

pub fn params<'k, 'v, P, V>(self, pairs: P) -> Self where
    P: AsRef<[(&'k str, V)]>,
    V: Display + 'v, 

Associated a list of pairs to query parameters.

The same key can be used multiple times.

pub fn header<H, V>(self, header: H, value: V) -> Self where
    H: IntoHeaderName,
    V: HttpTryInto<HeaderValue>, 

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: HttpTryInto<HeaderValue>, 

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 try_header<H, V>(self, header: H, value: V) -> Result<Self> where
    H: IntoHeaderName,
    V: HttpTryInto<HeaderValue>, 

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: HttpTryInto<HeaderValue>, 

Append a new header to this Request.

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

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

Enable HTTP bearer authentication.

pub fn text(self, body: impl AsRef<str>) -> RequestBuilder<impl AsRef<[u8]>>

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.

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

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 json<T: Serialize>(
    self,
    value: &T
) -> Result<RequestBuilder<impl AsRef<[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 form<T: Serialize>(
    self,
    value: &T
) -> Result<RequestBuilder<impl AsRef<[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 max_redirections(self, max_redirections: u32) -> Self

Set the maximum number of redirections this Request can perform.

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 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.

impl<B: AsRef<[u8]>> 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.

Trait Implementations

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

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

Formats the value using the given formatter.