Struct HttpClient 

pub struct HttpClient { /* private fields */ }

Represents a client to use for making HTTP requests.

Implementations

impl HttpClient

pub fn new() -> Self

Constructs a new HTTP client.

pub fn new_with_cache(cache_dir: impl AsRef<Path>) -> Self

Constructs a new HTTP client using the given cache directory.

pub fn from_existing(client: Client) -> Self

Constructs a new HTTP client using an existing client.

pub fn from_existing_with_cache( client: Client, cache_dir: impl AsRef<Path>, ) -> Self

Constructs a new HTTP client using an existing client and the given cache directory.

pub fn cache(&self) -> Option<&Cache<DefaultCacheStorage>>

Gets the associated cache.

If None, the client is not configured for caching.

Methods from Deref<Target = ClientWithMiddleware>

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 the 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 the 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 the 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 the 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 the 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 the 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 the request body before sending.

Errors

This method fails whenever the supplied Url cannot be parsed.

pub async fn execute(&self, req: 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, redirect loop was detected or redirect limit was exhausted.

pub async fn execute_with_extensions( &self, req: Request, ext: &mut Extensions, ) -> Result<Response, Error>

Executes a Request with initial Extensions.

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

impl Clone for HttpClient

fn clone(&self) -> HttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for HttpClient

fn default() -> Self

Returns the “default value” for a type.

impl Deref for HttpClient

type Target = ClientWithMiddleware

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.