Struct actix_web::HttpRequest
source · [−]pub struct HttpRequest { /* private fields */ }
Expand description
An incoming request.
Implementations
This method returns reference to the request head
The query string in the URL.
Example: id=10
Returns a reference to the URL parameters container.
A URL parameter is specified in the form {identifier}
, where the identifier can be used
later in a request handler to access the matched value for that parameter.
Percent Encoding and URL Parameters
Because each URL parameter is able to capture multiple path segments, none of
["%2F", "%25", "%2B"]
found in the request URI are decoded into ["/", "%", "+"]
in order
to preserve path integrity. If a URL parameter is expected to contain these characters, then
it is on the user to decode them or use the web::Path
extractor which
will decode these special sequences.
The resource definition pattern that matched the path. Useful for logging and metrics.
For example, when a resource with pattern /user/{id}/profile
is defined and a call is made
to /user/123/profile
this function would return Some("/user/{id}/profile")
.
Returns a None when no resource is fully matched, including default services.
The resource name that matched the path. Useful for logging and metrics.
Returns a None when no resource is fully matched, including default services.
Returns a reference a piece of connection data set in an on-connect callback.
let opt_t = req.conn_data::<PeerCertificate>();
pub fn url_for<U, I>(
&self,
name: &str,
elements: U
) -> Result<Url, UrlGenerationError> where
U: IntoIterator<Item = I>,
I: AsRef<str>,
pub fn url_for<U, I>(
&self,
name: &str,
elements: U
) -> Result<Url, UrlGenerationError> where
U: IntoIterator<Item = I>,
I: AsRef<str>,
Generates URL for a named resource.
This substitutes in sequence all URL parameters that appear in the resource itself and in parent scopes, if any.
It is worth noting that the characters ['/', '%']
are not escaped and therefore a single
URL parameter may expand into multiple path segments and elements
can be percent-encoded
beforehand without worrying about double encoding. Any other character that is not valid in
a URL path context is escaped using percent-encoding.
Examples
fn index(req: HttpRequest) -> HttpResponse {
let url = req.url_for("foo", &["1", "2", "3"]); // <- generate URL for "foo" resource
HttpResponse::Ok().into()
}
let app = App::new()
.service(web::resource("/test/{one}/{two}/{three}")
.name("foo") // <- set resource name so it can be used in `url_for`
.route(web::get().to(|| HttpResponse::Ok()))
);
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.
Get a reference to a ResourceMap
of current application.
Returns peer socket address.
Peer address is the directly connected peer’s socket address. If a proxy is used in front of the Actix Web server, then it would be address of this proxy.
For expanded client connection information, use connection_info
instead.
Will only return None when called in unit tests unless TestRequest::peer_addr
is used.
Returns connection info for the current request.
The return type, ConnectionInfo
, can also be used as an extractor.
Panics
Panics if request’s extensions container is already borrowed.
App config
Retrieves a piece of application state.
Extracts any object stored with App::app_data()
(or the
counterpart methods on Scope
and
Resource
) during application configuration.
Since the Actix Web router layers application data, the returned object will reference the
“closest” instance of the type. For example, if an App
stores a u32
, a nested Scope
also stores a u32
, and the delegated request handler falls within that Scope
, then
calling .app_data::<u32>()
on an HttpRequest
within that handler will return the
Scope
’s instance. However, using the same router set up and a request that does not get
captured by the Scope
, .app_data::<u32>()
would return the App
’s instance.
If the state was stored using the Data
wrapper, then it must also be retrieved using
this same type.
See also the Data
extractor.
Examples
let opt_t: Option<&Data<T>> = req.app_data::<Data<T>>();
Load request cookies.
Return request cookie.
Trait Implementations
It is possible to get HttpRequest
as an extractor handler parameter
Examples
use actix_web::{web, App, HttpRequest};
use serde::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))
);
}
Create a Self from request parts asynchronously.
Create a Self from request head asynchronously. Read more
Returns a reference to the request-local data/extensions container.
Returns a mutable reference to the request-local data/extensions container.
Message payload stream
Read the request content type. If request did not contain a Content-Type header, an empty string is returned. Read more
Get content type encoding. Read more
Convert the request content type to a known mime type.
Check if request has chunked transfer encoding.
Auto Trait Implementations
impl !RefUnwindSafe for HttpRequest
impl !Send for HttpRequest
impl !Sync for HttpRequest
impl Unpin for HttpRequest
impl !UnwindSafe for HttpRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more