Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

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.

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Available on non-crate feature async only.

Constructs a new Client.

Source

pub fn builder() -> ClientBuilder

Available on non-crate feature async only.

Creates a ClientBuilder to configure a Client.

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

Source

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

Available on non-crate feature async only.

Convenience method to make a GET request to a URL.

§Errors

This method fails whenever supplied Url cannot be parsed.

Source

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

Available on non-crate feature async only.

Convenience method to make a POST request to a URL.

§Errors

This method fails whenever supplied Url cannot be parsed.

Source

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

Available on non-crate feature async only.

Convenience method to make a PUT request to a URL.

§Errors

This method fails whenever supplied Url cannot be parsed.

Source

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

Available on non-crate feature async only.

Convenience method to make a PATCH request to a URL.

§Errors

This method fails whenever supplied Url cannot be parsed.

Source

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

Available on non-crate feature async only.

Convenience method to make a DELETE request to a URL.

§Errors

This method fails whenever supplied Url cannot be parsed.

Source

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

Available on non-crate feature async only.

Convenience method to make a HEAD request to a URL.

§Errors

This method fails whenever supplied Url cannot be parsed.

Source

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

Available on non-crate feature async only.

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.

Source

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

Available on non-crate feature async only.

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, redirect loop was detected or redirect limit was exhausted.

Trait Implementations§

Source§

impl Clone for Client

Available on non-crate feature async only.
Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Available on non-crate feature async only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Available on non-crate feature async only.
Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.