Struct awc::Client

pub struct Client(_);

An asynchronous HTTP and WebSocket client.

Examples

use awc::Client;

#[actix_rt::main]
async fn main() {
    let mut client = Client::default();

    let res = client.get("http://www.rust-lang.org") // <- Create request builder
        .insert_header(("User-Agent", "Actix-web"))
        .send()                             // <- Send HTTP request
        .await;                             // <- send request and wait for response

     println!("Response: {:?}", res);
}

Implementations

impl Client

pub fn new() -> Client

Create new client instance with default settings.

pub fn builder(
) -> ClientBuilder<impl Service<TcpConnect<Uri>, Response = TcpConnection<Uri, TcpStream>, Error = TcpConnectError> + Clone>

Create Client builder. This function is equivalent of ClientBuilder::new().

pub fn request<U>(&self, method: Method, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP request.

pub fn request_from<U>(&self, url: U, head: &RequestHead) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Create ClientRequest from RequestHead

It is useful for proxy requests. This implementation copies all headers and the method.

pub fn get<U>(&self, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP GET request.

pub fn head<U>(&self, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP HEAD request.

pub fn put<U>(&self, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP PUT request.

pub fn post<U>(&self, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP POST request.

pub fn patch<U>(&self, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP PATCH request.

pub fn delete<U>(&self, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP DELETE request.

pub fn options<U>(&self, url: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Construct HTTP OPTIONS request.

pub fn ws<U>(&self, url: U) -> WebsocketsRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<HttpError>, 

Initialize a WebSocket connection. Returns a WebSocket connection builder.

pub fn headers(&mut self) -> Option<&mut HeaderMap>

Get default HeaderMap of Client.

Returns Some(&mut HeaderMap) when Client object is unique (No other clone of client exists at the same time).

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.