Struct RequestHeader 

pub struct RequestHeader { /* private fields */ }

The HTTP request header type.

This type is similar to http::request::Parts but preserves header name case. It also preserves request path even if it is not UTF-8.

RequestHeader implements Deref for http::request::Parts so it can be used as it in most places.

Implementations

impl RequestHeader

pub fn build( method: impl TryInto<Method>, path: &[u8], size_hint: Option<usize>, ) -> Result<RequestHeader, Box<Error>>

Create a new RequestHeader with the given method and path.

The path can be non UTF-8.

pub fn build_no_case( method: impl TryInto<Method>, path: &[u8], size_hint: Option<usize>, ) -> Result<RequestHeader, Box<Error>>

Create a new RequestHeader with the given method and path without preserving header case.

A RequestHeader created from this type is more space efficient than those from Self::build().

Use this method if reading from or writing to HTTP/2 sessions where header case doesn’t matter anyway.

pub fn append_header( &mut self, name: impl IntoCaseHeaderName, value: impl TryInto<HeaderValue>, ) -> Result<bool, Box<Error>>

Append the header name and value to self.

If there are already some headers under the same name, a new value will be added without any others being removed.

pub fn insert_header( &mut self, name: impl IntoCaseHeaderName, value: impl TryInto<HeaderValue>, ) -> Result<(), Box<Error>>

Insert the header name and value to self.

Different from Self::append_header(), this method will replace all other existing headers under the same name (case-insensitive).

pub fn remove_header<'a, N>(&mut self, name: &'a N) -> Option<HeaderValue>

where &'a N: 'a + AsHeaderName, N: ?Sized,

Remove all headers under the name

pub fn header_to_h1_wire(&self, buf: &mut impl BufMut)

Write the header to the buf in HTTP/1.1 wire format.

The header case will be preserved.

pub fn set_method(&mut self, method: Method)

Set the request method

pub fn set_uri(&mut self, uri: Uri)

Set the request URI

pub fn set_raw_path(&mut self, path: &[u8]) -> Result<(), Box<Error>>

Set the request URI directly via raw bytes.

Generally prefer Self::set_uri() to modify the header’s URI if able.

This API is to allow supporting non UTF-8 cases.

pub fn set_send_end_stream(&mut self, send_end_stream: bool)

Set whether we send an END_STREAM on H2 request HEADERS if body is empty.

pub fn send_end_stream(&self) -> Option<bool>

Returns if we support sending an END_STREAM on H2 request HEADERS if body is empty, returns None if not H2.

pub fn raw_path(&self) -> &[u8]

Return the request path in its raw format

Non-UTF8 is supported.

pub fn uri_file_extension(&self) -> Option<&str>

Return the file extension of the path

pub fn set_version(&mut self, version: Version)

Set http version

pub fn as_owned_parts(&self) -> Parts

Clone self into http::request::Parts.

Trait Implementations

impl AsRef<Parts> for RequestHeader

fn as_ref(&self) -> &Parts

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for RequestHeader

fn clone(&self) -> RequestHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestHeader

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

Formats the value using the given formatter.

impl Deref for RequestHeader

type Target = Parts

The resulting type after dereferencing.

fn deref(&self) -> &<RequestHeader as Deref>::Target

Dereferences the value.

impl From<Parts> for RequestHeader

fn from(parts: Parts) -> RequestHeader

Converts to this type from the input type.

impl From<RequestHeader> for Parts

fn from(resp: RequestHeader) -> Parts

Converts to this type from the input type.