Struct actix_web::web::HttpRequest

pub struct HttpRequest(_);

An HTTP Request

Methods

impl HttpRequest

pub fn head(&self) -> &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 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 match_info(&self) -> &Path<Url>

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>

Request extensions

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

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

Generate url for named resource

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(|| HttpResponse::Ok()))
        );
}

pub fn url_for_static(&self, name: &str) -> Result<Url, UrlGenerationError>

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 connection_info(&self) -> Ref<ConnectionInfo>

Get ConnectionInfo for the current request.

pub fn app_config(&self) -> &AppConfig

App config

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

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

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

Load route data. Route data could be set during route configuration with Route::data() method.

Trait Implementations

impl<P> FromRequest<P> for HttpRequest

It is possible to get HttpRequest as an extractor handler parameter

Example

use actix_web::{web, App, HttpRequest};

/// extract `Thing` from request
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 = Error

The associated error which can be returned.

type Future = Result<Self, Error>

Future that resolves to a Self

fn from_request(req: &HttpRequest, _: &mut Payload<P>) -> Self::Future

Convert request to a Self

fn extract(req: &HttpRequest) -> Self::Future

Convert request to a Self

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a copy of the value.

default fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for HttpRequest

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for HttpRequest

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

Formats the value using the given formatter.

impl HttpMessage for HttpRequest

type Stream = ()

Type of message payload stream

fn headers(&self) -> &HeaderMap

Returns Request's headers.

fn extensions(&self) -> Ref<Extensions>

Request extensions

fn extensions_mut(&self) -> RefMut<Extensions>

Mutable reference to a the request's extensions

fn take_payload(&mut self) -> Payload<Self::Stream>

Message payload stream

default fn content_type(&self) -> &str

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

default fn encoding(
    &self
) -> Result<&'static (dyn Encoding + 'static + Send + Sync), ContentTypeError>

Get content type encoding

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

Convert the request content type to a known mime type.

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

Check if request has chunked transfer encoding

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

Load request cookies.

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

Return request cookie.