Skip to main content

RequestHead

Struct RequestHead 

Source
pub struct RequestHead {
    pub id: usize,
    pub uri: Url,
    pub method: Method,
    pub version: Version,
    pub headers: HeaderMap,
    pub headers_vec: Vec<HeaderItem>,
    pub extensions: RefCell<Extensions>,
    /* private fields */
}
Expand description

The parsed metadata for an HTTP request.

Fields§

§id: usize

Identifier of the connection that received the request.

§uri: Url

Request URI.

§method: Method

Request method.

§version: Version

HTTP protocol version.

§headers: HeaderMap

Parsed request headers.

§headers_vec: Vec<HeaderItem>

Headers in their original order and with their original names.

This collection is populated only when HttpServiceConfig::set_headers_vec is enabled.

§extensions: RefCell<Extensions>

Request-local type map.

Implementations§

Source§

impl RequestHead

Source

pub fn extensions(&self) -> Ref<'_, Extensions>

Returns the request extensions.

Source

pub fn extensions_mut(&self) -> RefMut<'_, Extensions>

Returns mutable access to the request extensions.

Source

pub fn headers(&self) -> &HeaderMap

Returns the request headers.

Source

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

Returns mutable access to the request headers.

Source

pub fn headers_vec(&self) -> &[HeaderItem]

Returns headers preserved in their original order and casing.

Source

pub fn set_connection_type(&mut self, ctype: ConnectionType)

Sets the request connection behavior.

Connection types are flags, and calling this method again does not clear a previously set type. When several are set, Close takes precedence over KeepAlive, which takes precedence over Upgrade.

Source

pub fn connection_type(&self) -> ConnectionType

Returns the request connection behavior.

Source

pub fn upgrade(&self) -> bool

Returns whether the request upgrades the connection.

Source

pub fn expect(&self) -> bool

Returns whether the request contains Expect: 100-continue.

Source

pub fn chunked(&self) -> bool

Returns whether chunked transfer encoding is allowed.

Source

pub fn no_chunking(&mut self, val: bool)

Enables or disables chunked transfer encoding.

A streaming request body without chunked coding requires a Content-Length header.

Source

pub fn peer_addr(&self) -> Option<SocketAddr>

Returns the peer socket address.

Peer address is actual socket address, if proxy is used in front of ntex http server, then peer address would be address of this proxy.

Source

pub fn take_io(&self) -> Option<(IoBoxed, Codec)>

Takes ownership of the I/O stream and HTTP/1 codec for an upgrade.

The handle is installed only after an upgrade is acknowledged through the HTTP/1 control service. This is a one-shot operation: subsequent calls return None.

Trait Implementations§

Source§

impl Debug for RequestHead

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RequestHead

Source§

fn default() -> RequestHead

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.