Struct http_req::request::Request

pub struct Request<'a> { /* fields omitted */ }

Relatively higher-level struct for making HTTP requests.

It creates stream (TcpStream or TlsStream) appropriate for the type of uri (http/https) By default it closes connection after completion of the response.

About timeouts:

• Default timeout for starting connection is 1 minute.
• On Linux, man 7 socket says that read/write timeouts default to zero, which means the operations will never time out. However, default value for this builder is 1 minute each.

Examples

use http_req::{request::Request, uri::Uri, response::StatusCode};

let mut writer = Vec::new();
let uri: Uri = "https://doc.rust-lang.org/".parse().unwrap();

let mut response = Request::new(&uri).send(&mut writer).unwrap();;

assert_eq!(response.status_code(), StatusCode::new(200));

Methods

impl<'a> Request<'a>

pub fn new(uri: &'a Uri) -> Request<'a>

Creates new Request with default parameters

pub fn headers<T>(&mut self, headers: T) -> &mut Self where
    Headers: From<T>, 

Replaces all it's headers with headers passed to the function

pub fn header<T: ?Sized, U: ?Sized>(&mut self, key: &T, val: &U) -> &mut Self where
    T: ToString,
    U: ToString, 

Adds header to existing/default headers

pub fn method<T>(&mut self, method: T) -> &mut Self where
    Method: From<T>, 

Changes request's method

pub fn set_method<T>(&mut self, method: T) where
    Method: From<T>, 

Deprecated:

Please use method instead

pub fn body(&mut self, body: &'a [u8]) -> &mut Self

Sets body for request

pub fn connect_timeout<T>(&mut self, timeout: Option<T>) -> &mut Self where
    Duration: From<T>, 

Sets connect timeout while using internal TcpStream instance

• If there is a timeout, it will be passed to TcpStream::connect_timeout.
• If None is provided, TcpStream::connect will be used, and it will not time out.

pub fn set_connect_timeout(&mut self, timeout: Option<Duration>) -> &mut Self

Deprecated:

Please use the read_timeout instead

pub fn read_timeout<T>(&mut self, timeout: Option<T>) -> &mut Self where
    Duration: From<T>, 

Sets read timeout on internal TcpStream instance

timeout will be passed to TcpStream::set_read_timeout.

pub fn set_read_timeout(&mut self, timeout: Option<Duration>) -> &mut Self

Deprecated:

Please use the read_timeout instead

pub fn write_timeout<T>(&mut self, timeout: Option<T>) -> &mut Self where
    Duration: From<T>, 

Sets write timeout on internal TcpStream instance

timeout will be passed to TcpStream::set_write_timeout.

pub fn set_write_timeout(&mut self, timeout: Option<Duration>) -> &mut Self

Deprecated:

Please use the write_timeout instead

pub fn send<T: Write>(&self, writer: &mut T) -> Result<Response, Error>

Sends HTTP request.

Creates TcpStream (and wraps it with TlsStream if needed). Writes request message to created stream. Returns response for this request. Writes response's body to writer.

Trait Implementations

impl<'a> PartialEq<Request<'a>> for Request<'a>

fn eq(&self, other: &Request<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Request<'a>) -> bool

This method tests for !=.

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.