Struct ntex::http::Request

pub struct Request { /* fields omitted */ }

Request

Implementations

impl Request

pub fn new() -> Request

Create new Request instance

impl Request

pub fn with_payload(payload: Payload) -> Request

Create new Request instance

pub fn head(&self) -> &RequestHead

Http message part of the request

pub fn uri(&self) -> &Uri

Request’s uri.

pub fn uri_mut(&mut self) -> &mut Uri

Mutable reference to the request’s uri.

pub fn method(&self) -> &Method

Read the Request method.

pub fn version(&self) -> Version

Read the Request Version.

pub fn path(&self) -> &str

The target path of this Request.

pub fn headers(&self) -> &HeaderMap

Request’s headers.

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

Mutable reference to the message’s headers.

pub fn upgrade(&self) -> bool

Check if request requires connection upgrade

pub fn io(&self) -> Option<&IoRef>

Io reference for current connection

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

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.

pub fn payload(&mut self) -> &mut Payload

Get request’s payload

pub fn take_payload(&mut self) -> Payload

Get request’s payload

pub fn replace_payload(&mut self, payload: Payload) -> Payload

Replace request’s payload, returns old one

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

Request extensions

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

Mutable reference to a the request’s extensions

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl HttpMessage for Request

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

Request extensions

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

Mutable reference to a the request’s extensions

fn message_headers(&self) -> &HeaderMap

Read the message headers.

fn content_type(&self) -> &str

Read the request content type. If request does not contain Content-Type header, empty str get returned.

fn encoding(&self) -> Result<&'static Encoding, ContentTypeError>

Get content type encoding

fn mime_type(&self) -> Result<Option<Mime>, ContentTypeError>

Convert the request content type to a known mime type.

fn chunked(&self) -> Result<bool, ParseError>

Check if request has chunked transfer encoding

fn cookies(&self) -> Result<Ref<'_, Vec<Cookie<'static>>>, ParseError>

Load request cookies.

fn cookie(&self, name: &str) -> Option<Cookie<'static>>

Return request cookie.

impl Service<Request> for ExpectHandler

type Response = Request

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = Ready<Self::Response, Self::Error>

The future response value.

fn poll_ready(&self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Ready when the service is able to process requests.

fn call(&self, req: Request) -> Self::Future

Process the request and return the response asynchronously.

fn poll_shutdown(&self, ctx: &mut Context<'_>, is_error: bool) -> Poll<()>

Shutdown service.

fn map<F, Res>(self, f: F) -> Map<Self, F, Req, Res> where
    F: FnMut(Self::Response) -> Res, 

Map this service’s output to a different type, returning a new service of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, Req, F, E> where
    F: Fn(Self::Error) -> E, 

Map this service’s error to a different error, returning a new service.

impl ServiceFactory<Request, ()> for ExpectHandler

type Response = Request

Responses given by the service

type Error = Error

Errors produced by the service

type Service = ExpectHandler

The Service value created by this factory

type InitError = Error

Errors produced while building a service.

type Future = Ready<Self::Service, Self::InitError>

The future of the ServiceFactory instance.

fn new_service(&self, _: ()) -> Self::Future

Create and return a new service value asynchronously.

fn map<F, Res>(self, f: F) -> MapServiceFactory<Self, F, Req, Res, Cfg> where
    F: FnMut(Self::Response) -> Res + Clone, 

Map this service’s output to a different type, returning a new service of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErrServiceFactory<Self, Req, Cfg, F, E> where
    F: Fn(Self::Error) -> E + Clone, 

Map this service’s error to a different error, returning a new service.

fn map_init_err<F, E>(self, f: F) -> MapInitErr<Self, Req, Cfg, F, E> where
    F: Fn(Self::InitError) -> E + Clone, 

Map this factory’s init error to a different error, returning a new service.