Struct Client

pub struct Client { /* private fields */ }

A Client to make Requests with.

The Client has various configuration values to tweak, but the defaults are set to what is usually the most commonly desired value. To configure a Client, use Client::builder().

The Client holds a connection pool internally, so it is advised that you create one and reuse it.

Examples

use reqwest::blocking::Client;
let client = Client::new();
let resp = client.get("http://httpbin.org/").send()?;

Implementations

impl Client

pub fn new() -> Client

Constructs a new Client.

Panic

This method panics if TLS backend cannot be initialized, or the resolver cannot load the system configuration.

Use Client::builder() if you wish to handle the failure as an Error instead of panicking.

This method also panics if called from within an async runtime. See docs on reqwest::blocking for details.

pub fn builder() -> ClientBuilder

Creates a ClientBuilder to configure a Client.

This is the same as ClientBuilder::new().

pub fn get<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a GET request to a URL.

Errors

This method fails whenever supplied Url cannot be parsed.

pub fn post<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a POST request to a URL.

Errors

This method fails whenever supplied Url cannot be parsed.

pub fn put<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a PUT request to a URL.

Errors

This method fails whenever supplied Url cannot be parsed.

pub fn patch<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a PATCH request to a URL.

Errors

This method fails whenever supplied Url cannot be parsed.

pub fn delete<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a DELETE request to a URL.

Errors

This method fails whenever supplied Url cannot be parsed.

pub fn head<U>(&self, url: U) -> RequestBuilder

where U: IntoUrl,

Convenience method to make a HEAD request to a URL.

Errors

This method fails whenever supplied Url cannot be parsed.

pub fn request<U>(&self, method: Method, url: U) -> RequestBuilder

where U: IntoUrl,

Start building a Request with the Method and Url.

Returns a RequestBuilder, which will allow setting headers and request body before sending.

Errors

This method fails whenever supplied Url cannot be parsed.

pub fn execute(&self, request: Request) -> Result<Response, Error>

Executes a Request.

A Request can be built manually with Request::new() or obtained from a RequestBuilder with RequestBuilder::build().

You should prefer to use the RequestBuilder and RequestBuilder::send().

Errors

This method fails if there was an error while sending request, or redirect limit was exhausted.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Client

Returns the “default value” for a type.