Struct ntex::http::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 ntex::http::client::Client;

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

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

Implementations

impl ClientRequest

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

Set HTTP URI of request.

pub fn get_uri(&self) -> &Uri

Get HTTP URI of request.

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

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(mut self: Self, method: Method) -> Self

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 headers(&self) -> &HeaderMap

Returns request's headers.

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

Returns request's mutable headers.

pub fn header<K, V>(mut self: Self, key: K, value: V) -> Self where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    <HeaderValue as TryFrom<V>>::Error: Into<HttpError>, 

Append a header.

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

use ntex::http;
use ntex::http::client::Client;

#[ntex::main]
async 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>(mut self: Self, key: K, value: V) -> Self where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    <HeaderValue as TryFrom<V>>::Error: Into<HttpError>, 

Insert a header, replaces existing header.

pub fn set_header_if_none<K, V>(mut self: Self, key: K, value: V) -> Self where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    <HeaderValue as TryFrom<V>>::Error: Into<HttpError>, 

Insert a header only if it is not yet set.

pub fn force_close(mut self: Self) -> Self

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

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

Set request's content type

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

Set content length

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

Set HTTP basic authorization header

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

Set HTTP bearer authentication header

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

Set a cookie

use coo_kie as cookie;
use ntex::http::client::Client;

#[ntex::main]
async fn main() {
    let resp = Client::new().get("https://www.rust-lang.org")
        .cookie(
            cookie::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(mut self: Self) -> Self

Disable automatic decompress of response's body

pub fn timeout(mut self: Self, timeout: Duration) -> Self

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 if_true<F>(self, value: bool, f: F) -> Self where
    F: FnOnce(ClientRequest) -> ClientRequest, 

This method calls provided closure with builder reference if value is true.

pub fn if_some<T, F>(self, value: Option<T>, f: F) -> Self where
    F: FnOnce(T, ClientRequest) -> ClientRequest, 

This method calls provided closure with builder reference if value is Some.

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

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: Serialize>(self, value: &T) -> SendClientRequest

Set a JSON body and generate ClientRequest

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

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
    S: Stream<Item = Result<Bytes, E>> + Unpin + 'static,
    E: Error + '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

Formats the value using the given formatter.