Struct Client 

pub struct Client { /* private fields */ }

An HTTP client.

use ntex::client::Client;

#[ntex::main]
async fn main() {
    let client = Client::new();

    let response = client
        .get("https://www.rust-lang.org")
        .header("User-Agent", "ntex")
        .send()
        .await;

    println!("Response: {response:?}");
}

Shutdown

Clones of a client share its connection pools. A pool is stopped once the last clone and every request created from it are dropped, and dropping does not wait for connections to close:

• Requests waiting for a connection fail with ConnectError::Disconnected.
• Idle HTTP/1 connections are shut down in the background, bounded by the I/O shutdown timeout.
• HTTP/2 connections stop accepting requests and are closed gracefully in the background once their in-flight requests have completed. Their closing is not bounded by a timeout.
• Responses that are still being read keep their connections. An HTTP/1 connection is closed instead of being returned to the stopped pool.
• A connection that is still being established is closed once the connect completes.

Implementations

impl Client

pub fn new() -> Client

Creates a client with default settings.

pub fn builder() -> ClientBuilder

Creates a client builder.

pub fn with_config(cfg: impl Into<SharedCfg>) -> Client

Creates a client with shared service configuration.

pub async fn ready(&self) -> Result<(), Error<ClientError>>

Waits until the client is ready to process requests.

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

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Creates an HTTP request with the specified method and URL.

pub fn request_from<U>(&self, url: U, head: &RequestHead) -> ClientRequest

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Creates a ClientRequest from a RequestHead.

This is useful for proxy requests. The method and headers are copied from head; existing client default headers are not overwritten.

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

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP GET request.

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

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP HEAD request.

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

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP PUT request.

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

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP POST request.

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

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP PATCH request.

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

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP DELETE request.

pub fn query<U>(&self, url: U) -> ClientRequest

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP QUERY request.

pub fn options<U>(&self, url: U) -> ClientRequest

where Url: TryFrom<U>, <Url as TryFrom<U>>::Error: Into<InvalidUrl>,

Construct HTTP OPTIONS request.

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.