Struct Request 

pub struct Request { /* private fields */ }

A request for a ClientConn to send.

HTTP/1.1 requires a Host field; the connection refuses to send a request without one. The request line always says HTTP/1.1.

Examples

use http_net::Request;

let get = Request::get("/index.html").header("host", "example.com");
let post = Request::post("/api")
    .header("host", "example.com")
    .header("content-type", "application/json")
    .body(br#"{"ok":true}"#.to_vec());
assert_eq!(get.method(), "GET");
assert_eq!(post.target(), "/api");

Implementations

impl Request

pub fn new(method: &str, target: &str) -> Self

A request with method and target, validated when it is sent: the method must be a token and the target must be in a form the method allows (/path?query, an absolute URI, host:port for CONNECT, or * for OPTIONS).

Examples

let r = http_net::Request::new("PURGE", "/cache/a");
assert_eq!(r.method(), "PURGE");

pub fn get(target: &str) -> Self

A GET request.

Examples

assert_eq!(http_net::Request::get("/").method(), "GET");

pub fn post(target: &str) -> Self

A POST request.

Examples

assert_eq!(http_net::Request::post("/").method(), "POST");

pub fn head(target: &str) -> Self

A HEAD request: its response carries headers and no body.

Examples

assert_eq!(http_net::Request::head("/").method(), "HEAD");

pub fn put(target: &str) -> Self

A PUT request.

Examples

assert_eq!(http_net::Request::put("/files/a").method(), "PUT");

pub fn delete(target: &str) -> Self

A DELETE request.

Examples

assert_eq!(http_net::Request::delete("/files/a").method(), "DELETE");

pub fn options(target: &str) -> Self

An OPTIONS request; * asks about the server as a whole.

Examples

assert_eq!(http_net::Request::options("*").target(), "*");

pub fn header(self, name: &str, value: impl AsRef<[u8]>) -> Self

Adds a header field, validated as for Response::header. A second host is refused with HttpError::InvalidHost.

Examples

let r = http_net::Request::get("/").header("host", "a").header("accept", "*/*");
assert_eq!(r.header_value("accept"), Some(&b"*/*"[..]));

pub fn body(self, body: impl Into<Cow<'static, [u8]>>) -> Self

Sets the whole body, sent with content-length.

Examples

let r = http_net::Request::post("/").body(&b"x=1"[..]);
assert_eq!(r.body_bytes(), Some(&b"x=1"[..]));

pub fn chunked(self) -> Self

Streams the body with chunked encoding through ClientConn::send_body and ClientConn::end_body.

Examples

assert_eq!(http_net::Request::post("/").chunked().body_bytes(), None);

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

Streams a body of exactly len bytes.

Examples

assert_eq!(http_net::Request::post("/").content_length(4).body_bytes(), None);

pub fn close(self) -> Self

Asks the server to close the connection after its response.

Examples

let _ = http_net::Request::get("/").header("host", "a").close();

pub fn upgrade(self, protocol: &str) -> Self

Asks to switch the connection to protocol (writes connection: upgrade and upgrade: <protocol>). A 101 answer hands the connection over; see ClientEvent::Upgraded.

protocol is a token or a name/version product token. h2c is refused with HttpError::UpgradeNotOffered: RFC 9113 section 3.1 deprecates the HTTP/2 upgrade.

Examples

use http_net::{ClientConn, HttpError, Request};

let r = Request::get("/rpc").header("host", "a").upgrade("websocket");
assert_eq!(r.header_value("upgrade"), Some(&b"websocket"[..]));

let h2c = Request::get("/").header("host", "a").upgrade("h2c");
assert_eq!(
    ClientConn::new().send_request(&h2c, &mut Vec::new()),
    Err(HttpError::UpgradeNotOffered)
);

pub fn method(&self) -> &str

The method text.

Examples

assert_eq!(http_net::Request::new("OPTIONS", "*").method(), "OPTIONS");

pub fn target(&self) -> &str

The request target.

Examples

assert_eq!(http_net::Request::get("/a?b").target(), "/a?b");

pub fn body_bytes(&self) -> Option<&[u8]>

The full body, or None for a streamed one.

Examples

assert_eq!(http_net::Request::get("/").body_bytes(), Some(&[][..]));

pub fn header_value(&self, name: &str) -> Option<&[u8]>

The value of the first header named name added to this request.

Examples

let r = http_net::Request::get("/").header("host", "a");
assert_eq!(r.header_value("HOST"), Some(&b"a"[..]));

Trait Implementations

impl Clone for Request

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

Shows method, target, fields, and body size; the values of credential fields (authorization, proxy-authorization, cookie) are replaced by <redacted N bytes>.

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

Formats the value using the given formatter.

impl Eq for Request

impl PartialEq for Request

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Request