Struct ntex::web::WebRequest

pub struct WebRequest<Err> { /* private fields */ }

An service http request

WebRequest allows mutable access to request’s internal structures

Implementations

impl<Err: ErrorRenderer> WebRequest<Err>

pub fn render_error<E: WebResponseError<Err>>(self, err: E) -> WebResponse

Create web response for error

pub fn error_response<E: Into<Err::Container>>(self, err: E) -> WebResponse

Create web response for error

impl<Err> WebRequest<Err>

pub fn into_parts(self) -> (HttpRequest, Payload)

Deconstruct request into parts

pub fn from_parts( req: HttpRequest, pl: Payload ) -> Result<Self, (HttpRequest, Payload)>

Construct request from parts.

WebRequest can be re-constructed only if req hasnt been cloned.

pub fn from_request(req: HttpRequest) -> Result<Self, HttpRequest>

Construct request from request.

HttpRequest implements Clone trait via Rc type. WebRequest can be re-constructed only if rc’s strong pointers count eq 1 and weak pointers count is 0.

pub fn into_response<R: Into<Response>>(self, res: R) -> WebResponse

Create web response

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

Io reference for current connection

pub fn head(&self) -> &RequestHead

This method returns reference to the request head

pub fn head_mut(&mut self) -> &mut RequestHead

This method returns reference to the request head

pub fn uri(&self) -> &Uri

Request’s uri.

pub fn method(&self) -> &Method

Read the Request method.

pub fn version(&self) -> Version

Read the Request Version.

pub fn headers(&self) -> &HeaderMap

Returns request’s headers.

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

Returns mutable request’s headers.

pub fn path(&self) -> &str

The target path of this Request.

pub fn query_string(&self) -> &str

The query string in the URL.

E.g., id=10

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.

To get client connection information ConnectionInfo should be used.

pub fn connection_info(&self) -> Ref<'_, ConnectionInfo>

Get ConnectionInfo for the current request.

pub fn match_info(&self) -> &Path<Uri>

Get a reference to the Path parameters.

Params is a container for url parameters. A variable segment is specified in the form {identifier}, where the identifier can be used later in a request handler to access the matched value for that segment.

pub fn match_info_mut(&mut self) -> &mut Path<Uri>

Get a mutable reference to the Path parameters.

pub fn resource_map(&self) -> &ResourceMap

Get a reference to a ResourceMap of current application.

pub fn app_config(&self) -> &AppConfig

Service configuration

pub fn app_state<T: 'static>(&self) -> Option<&T>

Get an application state stored with App::app_state() method during application configuration.

To get state stored with App::state() use web::types::State<T> as type.

pub fn take_payload(&mut self) -> Payload

Get request’s payload

pub fn set_payload(&mut self, payload: Payload)

Set request payload.

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<Err: ErrorRenderer> Debug for WebRequest<Err>

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

Formats the value using the given formatter.

impl<Err> HttpMessage for WebRequest<Err>

fn message_headers(&self) -> &HeaderMap

Returns Request’s headers.

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

Request extensions

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

Mutable reference to a the request’s extensions

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, DecodeError>

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<Err> Resource<Uri> for WebRequest<Err>

fn path(&self) -> &str

fn resource_path(&mut self) -> &mut Path<Uri>

impl<Err: ErrorRenderer> ServiceFactory<WebRequest<Err>> for Route<Err>

type Response = WebResponse

Responses given by the created services.

type Error = <Err as ErrorRenderer>::Container

Errors produced by the created services.

type InitError = ()

Errors potentially raised while building a service.

type Service = RouteService<Err>

The kind of Service created by this factory.

async fn create(&self, _: ()) -> Result<RouteService<Err>, ()>

Create and return a new service value asynchronously.

async fn pipeline( &self, cfg: Cfg ) -> Result<Pipeline<Self::Service>, Self::InitError>

where Self: Sized,

Create and return a new service value asynchronously and wrap into a container

fn map<F, Res>( self, f: F ) -> ServiceChainFactory<MapFactory<Self, F, Req, Res, Cfg>, Req, Cfg>

where Self: Sized, F: Fn(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 ) -> ServiceChainFactory<MapErrFactory<Self, Req, Cfg, F, E>, Req, Cfg>

where Self: Sized, 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 ) -> ServiceChainFactory<MapInitErr<Self, Req, Cfg, F, E>, Req, Cfg>

where Self: Sized, F: Fn(Self::InitError) -> E + Clone,

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