Struct Client

pub struct Client { /* private fields */ }

An asynchronous 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.

You do not have to wrap the Client in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl Client

pub fn new() -> Client

Constructs a new Client.

Panics

This method panics if a 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.

pub fn builder() -> ClientBuilder

Create a ClientBuilder specifically configured for WebSocket connections.

This method configures the ClientBuilder to use HTTP/1.0 only, which is required for certain WebSocket connections.

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

Upgrades the RequestBuilder to perform a websocket handshake. This returns a wrapped type, so you must do this after you set up your request, and just before you send the request.

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 fn execute( &self, request: Request, ) -> impl Future<Output = 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.

impl Client

pub fn user_agent(&self) -> Option<HeaderValue>

Retrieves the User-Agent header for this client.

This method returns the User-Agent header value if it is set for this client.

Returns

An Option<HeaderValue> containing the User-Agent header value if it is set, or None if it is not.

pub fn headers(&self) -> HeaderMap

Retrieves a headers for this client.

This method returns a HeaderMap containing the headers for this client. Note that this operation involves cloning the headers, which can be expensive if the header map is large.

Returns

A HeaderMap containing the headers for this client.

pub fn get_cookies(&self, url: &Url) -> Option<HeaderValue>

Returns a String of the header-value of all Cookie in a Url.

pub fn set_cookies<C>(&self, url: &Url, cookies: C)

where C: AsRef<[HeaderValue]>,

Injects a ‘Cookie’ into the ‘CookieStore’ for the specified URL.

This method accepts a collection of cookies, which can be either an owned vector (Vec<HeaderValue>) or a reference to a slice (&[HeaderValue]). It will convert the collection into an iterator and pass it to the cookie_store for processing.

Parameters

• url: The URL associated with the cookies to be set.
• cookies: A collection of HeaderValue items, either by reference or owned.

This method ensures that cookies are only set if at least one cookie exists in the collection.

pub fn set_cookie<'c, C>(&self, url: &Url, cookie: C)

where C: IntoCookie + 'c,

Inserts a cookie into the CookieStore for the specified URL.

Note

This method requires the cookies feature to be enabled.

pub fn remove_cookie(&self, url: &Url, name: &str)

Removes a cookie from the CookieStore for the specified URL.

This method deletes a cookie with the given name from the client’s CookieStore for the specified URL. It can be useful in scenarios where you want to remove specific cookies to reset the client’s state or ensure that certain cookies are not sent with subsequent requests.

Parameters

• url: The URL associated with the cookie to be removed.
• name: The name of the cookie to be removed.

Note

This method requires the cookies feature to be enabled.

pub fn clear_cookies(&self)

Clears all cookies from the CookieStore.

This method removes all cookies stored in the client’s CookieStore. It can be useful in scenarios where you want to reset the client’s state or ensure that no cookies are sent with subsequent requests.

Note

This method requires the cookies feature to be enabled.

pub fn update(&self) -> ClientUpdate<'_>

Returns a ClientUpdate instance to modify the internal state of the Client.

This method allows you to obtain a ClientUpdate instance, which provides methods to mutate the internal state of the Client. This is useful when you need to modify the client’s configuration or state after it has been created.

Returns

A ClientUpdate<'_> instance that can be used to modify the internal state of the Client.

Example

let client = rquest::Client::new();
client.update()
    .headers(|headers| {
        headers.insert("X-Custom-Header", HeaderValue::from_static("value"));
    })
    .apply()
    .unwrap();

pub fn cloned(&self) -> Self

Clones the Client into a new instance.

This method creates a new instance of the Client by cloning its internal state. The cloned client will have the same configuration and state as the original client, but it will be a separate instance that can be used independently. Note that this will still share the connection pool with the original Client.

Example

let client = rquest::Client::new();
let cloned_client = client.cloned();
// Use the cloned client independently

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.

impl Service<Request> for &Client

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<(), Self::Error>>

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 Client

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<(), Self::Error>>

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.