Struct actix_web::client::ClientRequest

pub struct ClientRequest { /* fields omitted */ }

An HTTP Client request builder

This type can be used to construct an instance of ClientRequest through a builder-like pattern.

use actix_rt::System;

#[actix_rt::main]
async fn main() {
   let response = awc::Client::new()
        .get("http://www.rust-lang.org") // <- Create request builder
        .header("User-Agent", "Actix-web")
        .send()                          // <- Send http request
        .await;

   response.and_then(|response| {   // <- server http response
        println!("Response: {:?}", response);
        Ok(())
   });
}

Implementations

impl ClientRequest

pub fn uri<U>(self, uri: U) -> ClientRequest where
    Uri: TryFrom<U>,
    <Uri as TryFrom<U>>::Error: Into<Error>, 

Set HTTP URI of request.

pub fn get_uri(&self) -> &Uri

Get HTTP URI of request.

pub fn address(self, addr: SocketAddr) -> ClientRequest

Set socket address of the server.

This address is used for connection. If address is not provided url's host name get resolved.

pub fn method(self, method: Method) -> ClientRequest

Set HTTP method of this request.

pub fn get_method(&self) -> &Method

Get HTTP method of this request

pub fn get_version(&self) -> &Version

Get HTTP version of this request.

pub fn get_peer_addr(&self) -> &Option<SocketAddr>

Get peer address of this request.

pub fn headers(&self) -> &HeaderMap

Returns request's headers.

pub fn headers_mut(&mut self) -> &mut HeaderMap

Returns request's mutable headers.

pub fn set<H>(self, hdr: H) -> ClientRequest where
    H: Header, 

Set a header.

fn main() {
    let req = awc::Client::new()
        .get("http://www.rust-lang.org")
        .set(awc::http::header::Date::now())
        .set(awc::http::header::ContentType(mime::TEXT_HTML));
}

pub fn header<K, V>(self, key: K, value: V) -> ClientRequest where
    V: IntoHeaderValue,
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<Error>, 

Append a header.

Header gets appended to existing header. To override header use set_header() method.

use awc::{http, Client};

fn main() {
    let req = Client::new()
        .get("http://www.rust-lang.org")
        .header("X-TEST", "value")
        .header(http::header::CONTENT_TYPE, "application/json");
}

pub fn set_header<K, V>(self, key: K, value: V) -> ClientRequest where
    V: IntoHeaderValue,
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<Error>, 

Insert a header, replaces existing header.

pub fn set_header_if_none<K, V>(self, key: K, value: V) -> ClientRequest where
    V: IntoHeaderValue,
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<Error>, 

Insert a header only if it is not yet set.

pub fn camel_case(self) -> ClientRequest

Send headers in Camel-Case form.

pub fn force_close(self) -> ClientRequest

Force close connection instead of returning it back to connections pool. This setting affect only http/1 connections.

pub fn content_type<V>(self, value: V) -> ClientRequest where
    HeaderValue: TryFrom<V>,
    <HeaderValue as TryFrom<V>>::Error: Into<Error>, 

Set request's content type

pub fn content_length(self, len: u64) -> ClientRequest

Set content length

pub fn basic_auth<U>(self, username: U, password: Option<&str>) -> ClientRequest where
    U: Display, 

Set HTTP basic authorization header

pub fn bearer_auth<T>(self, token: T) -> ClientRequest where
    T: Display, 

Set HTTP bearer authentication header

pub fn cookie(self, cookie: Cookie<'_>) -> ClientRequest

Set a cookie

#[actix_rt::main]
async fn main() {
    let resp = awc::Client::new().get("https://www.rust-lang.org")
        .cookie(
            awc::http::Cookie::build("name", "value")
                .domain("www.rust-lang.org")
                .path("/")
                .secure(true)
                .http_only(true)
                .finish(),
         )
         .send()
         .await;

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

pub fn no_decompress(self) -> ClientRequest

Disable automatic decompress of response's body

pub fn timeout(self, timeout: Duration) -> ClientRequest

Set request timeout. Overrides client wide timeout setting.

Request timeout is the total time before a response must be received. Default value is 5 seconds.

pub fn query<T>(self, query: &T) -> Result<ClientRequest, Error> where
    T: Serialize, 

Sets the query part of the request

pub fn freeze(self) -> Result<FrozenClientRequest, FreezeRequestError>

Freeze request builder and construct FrozenClientRequest, which could be used for sending same request multiple times.

pub fn send_body<B>(self, body: B) -> SendClientRequest where
    B: Into<Body>, 

Complete request construction and send body.

pub fn send_json<T>(self, value: &T) -> SendClientRequest where
    T: Serialize, 

Set a JSON body and generate ClientRequest

pub fn send_form<T>(self, value: &T) -> SendClientRequest where
    T: Serialize, 

Set a urlencoded body and generate ClientRequest

ClientRequestBuilder can not be used after this call.

pub fn send_stream<S, E>(self, stream: S) -> SendClientRequest where
    E: Into<Error> + 'static,
    S: Stream<Item = Result<Bytes, E>> + Unpin + 'static, 

Set an streaming body and generate ClientRequest.

pub fn send(self) -> SendClientRequest

Set an empty body and generate ClientRequest.

Trait Implementations

impl Debug for ClientRequest

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

Formats the value using the given formatter.