Struct ntex::web::HttpRequest [−][src]
An HTTP Request
Implementations
impl HttpRequest
[src]
pub fn head(&self) -> &RequestHead
[src]
This method returns reference to the request head
pub fn uri(&self) -> &Uri
[src]
Request's uri.
pub fn method(&self) -> &Method
[src]
Read the Request method.
pub fn version(&self) -> Version
[src]
Read the Request Version.
pub fn headers(&self) -> &HeaderMap
[src]
Returns request's headers.
pub fn path(&self) -> &str
[src]
The target path of this Request.
pub fn query_string(&self) -> &str
[src]
The query string in the URL.
E.g., id=10
pub fn match_info(&self) -> &Path<Uri>
[src]
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 extensions(&self) -> Ref<'_, Extensions>
[src]
Request extensions
pub fn extensions_mut(&self) -> RefMut<'_, Extensions>
[src]
Mutable reference to a the request's extensions
pub fn url_for<U, I>(
&self,
name: &str,
elements: U
) -> Result<Url, UrlGenerationError> where
U: IntoIterator<Item = I>,
I: AsRef<str>,
[src]
&self,
name: &str,
elements: U
) -> Result<Url, UrlGenerationError> where
U: IntoIterator<Item = I>,
I: AsRef<str>,
Generate url for named resource
async fn index(req: HttpRequest) -> HttpResponse { let url = req.url_for("foo", &["1", "2", "3"]); // <- generate url for "foo" resource HttpResponse::Ok().into() } fn main() { let app = App::new() .service(web::resource("/test/{one}/{two}/{three}") .name("foo") // <- set resource name, then it could be used in `url_for` .route(web::get().to(index)) ); }
pub fn url_for_static(&self, name: &str) -> Result<Url, UrlGenerationError>
[src]
Generate url for named resource
This method is similar to HttpRequest::url_for()
but it can be used
for urls that do not contain variable parts.
pub fn resource_map(&self) -> &ResourceMap
[src]
Get a reference to a ResourceMap
of current application.
pub fn peer_addr(&self) -> Option<SocketAddr>
[src]
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 .connection_info()
should be used.
pub fn connection_info(&self) -> Ref<'_, ConnectionInfo>
[src]
Get ConnectionInfo for the current request.
This method panics if request's extensions container is already borrowed.
pub fn app_config(&self) -> &AppConfig
[src]
App config
pub fn app_data<T: 'static>(&self) -> Option<&T>
[src]
Get an application data object stored with App::data
or App::app_data
methods during application configuration.
If App::data
was used to store object, use Data<T>
:
let opt_t = req.app_data::<Data<T>>();
Trait Implementations
impl Clone for HttpRequest
[src]
fn clone(&self) -> HttpRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for HttpRequest
[src]
impl Drop for HttpRequest
[src]
impl<Err: ErrorRenderer> FromRequest<Err> for HttpRequest
[src]
It is possible to get HttpRequest
as an extractor handler parameter
Example
use ntex::web::{self, App, HttpRequest}; use serde_derive::Deserialize; /// extract `Thing` from request async fn index(req: HttpRequest) -> String { format!("Got thing: {:?}", req) } fn main() { let app = App::new().service( web::resource("/users/{first}").route( web::get().to(index)) ); }
type Error = Err::Container
The associated error which can be returned.
type Future = Ready<Result<Self, Self::Error>>
Future that resolves to a Self
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
[src]
fn extract(req: &HttpRequest) -> Self::Future
[src]
impl HttpMessage for HttpRequest
[src]
fn message_headers(&self) -> &HeaderMap
[src]
Returns Request's headers.
fn message_extensions(&self) -> Ref<'_, Extensions>
[src]
Request extensions
fn message_extensions_mut(&self) -> RefMut<'_, Extensions>
[src]
Mutable reference to a the request's extensions
fn content_type(&self) -> &str
[src]
fn encoding(&self) -> Result<&'static Encoding, ContentTypeError>
[src]
fn mime_type(&self) -> Result<Option<Mime>, ContentTypeError>
[src]
fn chunked(&self) -> Result<bool, ParseError>
[src]
fn cookies(&self) -> Result<Ref<'_, Vec<Cookie<'static>>>, ParseError>
[src]
fn cookie(&self, name: &str) -> Option<Cookie<'static>>
[src]
Auto Trait Implementations
impl !RefUnwindSafe for HttpRequest
[src]
impl !Send for HttpRequest
[src]
impl !Sync for HttpRequest
[src]
impl Unpin for HttpRequest
[src]
impl !UnwindSafe for HttpRequest
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,