Struct actix_web::client::ClientRequestBuilder
[−]
[src]
pub struct ClientRequestBuilder { /* fields omitted */ }An HTTP Client request builder
This type can be used to construct an instance of ClientRequest through a
builder-like pattern.
Methods
impl ClientRequestBuilder[src]
fn uri<U>(&mut self, uri: U) -> &mut Self where
Uri: HttpTryFrom<U>, [src]
Uri: HttpTryFrom<U>,
Set HTTP uri of request.
fn method(&mut self, method: Method) -> &mut Self[src]
Set HTTP method of this request.
fn version(&mut self, version: Version) -> &mut Self[src]
Set HTTP version of this request.
By default requests's http version depends on network stream
fn header<K, V>(&mut self, key: K, value: V) -> &mut Self where
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>, [src]
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
Add a header.
Header get appended to existing header.
To override header use set_header() method.
use http::header; fn main() { let req = ClientRequest::build() .header("X-TEST", "value") .header(header::CONTENT_TYPE, "application/json") .finish().unwrap(); }
fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self where
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>, [src]
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
Replace a header.
fn content_encoding(&mut self, enc: ContentEncoding) -> &mut Self[src]
Set content encoding.
By default ContentEncoding::Identity is used.
fn chunked(&mut self) -> &mut Self[src]
Enables automatic chunked transfer encoding
fn upgrade(&mut self) -> &mut Self[src]
Enable connection upgrade
fn content_type<V>(&mut self, value: V) -> &mut Self where
HeaderValue: HttpTryFrom<V>, [src]
HeaderValue: HttpTryFrom<V>,
Set request's content type
fn content_length(&mut self, len: u64) -> &mut Self[src]
Set content length
[src]
Set a cookie
use actix_web::headers::Cookie; use actix_web::client::ClientRequest; fn main() { let req = ClientRequest::build() .cookie( Cookie::build("name", "value") .domain("www.rust-lang.org") .path("/") .secure(true) .http_only(true) .finish()) .finish().unwrap(); }
[src]
Remove cookie, cookie has to be cookie from HttpRequest::cookies() method.
fn no_default_headers(&mut self) -> &mut Self[src]
Do not add default request headers.
By default Accept-Encoding header is set.
fn disable_decompress(&mut self) -> &mut Self[src]
Disable automatic decompress response body
fn buffer_capacity(
&mut self,
low_watermark: usize,
high_watermark: usize
) -> &mut Self[src]
&mut self,
low_watermark: usize,
high_watermark: usize
) -> &mut Self
Set write buffer capacity
fn with_connector(&mut self, conn: Addr<Unsync, ClientConnector>) -> &mut Self[src]
Send request using custom connector
fn with_connection(&mut self, conn: Connection) -> &mut Self[src]
Send request using existing Connection
fn if_true<F>(&mut self, value: bool, f: F) -> &mut Self where
F: FnOnce(&mut ClientRequestBuilder), [src]
F: FnOnce(&mut ClientRequestBuilder),
This method calls provided closure with builder reference if value is true.
fn if_some<T, F>(&mut self, value: Option<T>, f: F) -> &mut Self where
F: FnOnce(T, &mut ClientRequestBuilder), [src]
F: FnOnce(T, &mut ClientRequestBuilder),
This method calls provided closure with builder reference if value is Some.
fn body<B: Into<Body>>(&mut self, body: B) -> Result<ClientRequest, HttpError>[src]
Set a body and generate ClientRequest.
ClientRequestBuilder can not be used after this call.
fn json<T: Serialize>(&mut self, value: T) -> Result<ClientRequest, Error>[src]
Set a json body and generate ClientRequest
ClientRequestBuilder can not be used after this call.
fn finish(&mut self) -> Result<ClientRequest, HttpError>[src]
Set an empty body and generate ClientRequest
ClientRequestBuilder can not be used after this call.
fn take(&mut self) -> ClientRequestBuilder[src]
This method construct new ClientRequestBuilder