Struct reqwest_middleware::ClientWithMiddleware

pub struct ClientWithMiddleware { /* private fields */ }

ClientWithMiddleware is a wrapper around reqwest::Client which runs middleware on every request.

Implementations

impl ClientWithMiddleware

pub fn new<T>(client: Client, middleware_stack: T) -> Self

where T: Into<Box<[Arc<dyn Middleware>]>>,

See ClientBuilder for a more ergonomic way to build ClientWithMiddleware instances.

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

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: IntoUrl>(&self, url: U) -> RequestBuilder

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: IntoUrl>(&self, url: U) -> RequestBuilder

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: IntoUrl>(&self, url: U) -> RequestBuilder

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: IntoUrl>(&self, url: U) -> RequestBuilder

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: IntoUrl>(&self, url: U) -> RequestBuilder

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: IntoUrl>(&self, method: Method, url: U) -> RequestBuilder

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>

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>

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 ClientWithMiddleware

fn clone(&self) -> ClientWithMiddleware

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientWithMiddleware

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

Formats the value using the given formatter.

impl Default for ClientWithMiddleware

fn default() -> ClientWithMiddleware

Returns the “default value” for a type.

impl From<Client> for ClientWithMiddleware

Create a ClientWithMiddleware without any middleware.

fn from(client: Client) -> Self

Converts to this type from the input type.

impl Service<Request> for &ClientWithMiddleware

type Response = Response

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = Pending

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request) -> Self::Future

Process the request and return the response asynchronously.

impl Service<Request> for ClientWithMiddleware

type Response = Response

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = Pending

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request) -> Self::Future

Process the request and return the response asynchronously.