Struct minreq::Request

pub struct Request { /* fields omitted */ }

An HTTP request.

Generally created by the minreq::get-style functions, corresponding to the HTTP method we want to use.

Example

let request = minreq::post("http://example.com");

After creating the request, you would generally call send or send_lazy on it, as it doesn't do much on its own.

Implementations

impl Request

pub fn new<T: Into<URL>>(method: Method, url: T) -> Request

Creates a new HTTP Request.

This is only the request's data, it is not sent yet. For sending the request, see send.

pub fn with_header<T: Into<String>, U: Into<String>>(
    self,
    key: T,
    value: U
) -> Request

Adds a header to the request this is called on. Use this function to add headers to your requests.

pub fn with_body<T: Into<Vec<u8>>>(self, body: T) -> Request

Sets the request body.

pub fn with_json<T: Serialize>(self, body: &T) -> Result<Request, Error>

Converts given argument to JSON and sets it as body.

Errors

Returns SerdeJsonError if Serde runs into a problem when converting body into a string.

pub fn with_timeout(self, timeout: u64) -> Request

Sets the request timeout in seconds.

pub fn with_max_redirects(self, max_redirects: usize) -> Request

Sets the max redirects we follow until giving up. 100 by default.

Warning: setting this to a very high number, such as 1000, may cause a stack overflow if that many redirects are followed. If you have a use for so many redirects that the stack overflow becomes a problem, please open an issue.

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

Sends this request to the host.

Errors

Returns Err if we run into an error while sending the request, or receiving/parsing the response. The specific error is described in the Err, and it can be any minreq::Error except SerdeJsonError and InvalidUtf8InBody.

pub fn send_lazy(self) -> Result<ResponseLazy, Error>

Sends this request to the host, loaded lazily.

Errors

See send.

pub fn with_proxy(self, proxy: Proxy) -> Request

Sets the proxy to use.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl PartialEq<Request> for Request

fn eq(&self, other: &Request) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Request) -> bool

This method tests for !=.

impl StructuralPartialEq for Request