Struct actix_web::HttpRequest

pub struct HttpRequest<S = ()> { /* private fields */ }

An HTTP Request

Implementations

impl<S> HttpRequest<S>

pub fn drop_state(&self) -> HttpRequest

Construct new http request with empty state.

pub fn state(&self) -> &S

Shared application state

pub fn request(&self) -> &Request

Server request

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 response(&self, status: StatusCode, body: Body) -> HttpResponse

Create http response

pub fn build_response(&self, status: StatusCode) -> HttpResponseBuilder

Create http response builder

pub fn uri(&self) -> &Uri

Read the Request 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 connection_info(&self) -> Ref<'_, ConnectionInfo>

Get ConnectionInfo for the correct request.

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()
        .resource("/test/{one}/{two}/{three}", |r| {
             r.name("foo");  // <- set resource name, then it could be used in `url_for`
             r.method(http::Method::GET).f(|_| HttpResponse::Ok());
        })
        .finish();
}

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 resource(&self) -> &ResourceInfo

This method returns reference to current ResourceInfo object.

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

Peer socket address

Peer address is actual socket address, if proxy is used in front of actix http server, then peer address would be address of this proxy.

To get client connection information connection_info() method should be used.

pub fn query(&self) -> Ref<'_, HashMap<String, String>>

url query parameters.

pub fn query_string(&self) -> &str

The query string in the URL.

E.g., id=10

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

Load request cookies.

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

Return request cookie.

pub fn match_info(&self) -> &Params

Get a reference to the Params object.

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 set_read_buffer_capacity(&mut self, cap: usize)

Set read buffer capacity

Default buffer capacity is 32Kb.

Methods from Deref<Target = Request>

pub fn uri(&self) -> &Uri

Read the Request 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

Returns Request’s headers.

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

Peer socket address

Peer address is actual socket address, if proxy is used in front of actix http server, then peer address would be address of this proxy.

To get client connection information connection_info() method should be used.

pub fn keep_alive(&self) -> bool

Checks if a connection should be kept alive.

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 upgrade(&self) -> bool

Check if request requires connection upgrade

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

Get ConnectionInfo for the correct request.

pub fn stream_extensions(&self) -> Option<&Extensions>

Io stream extensions

pub fn server_settings(&self) -> &ServerSettings

Server settings

Trait Implementations

impl<S> Clone for HttpRequest<S>

fn clone(&self) -> HttpRequest<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for HttpRequest<S>

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

Formats the value using the given formatter.

impl<S> Deref for HttpRequest<S>

type Target = Request

The resulting type after dereferencing.

fn deref(&self) -> &Request

Dereferences the value.

impl<S> Drop for HttpRequest<S>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, S: 'static> From<&'a HttpRequest<S>> for ClientRequestBuilder

Create ClientRequestBuilder from HttpRequest

It is useful for proxy requests. This implementation copies all request headers and the method.

fn from(req: &'a HttpRequest<S>) -> ClientRequestBuilder

Converts to this type from the input type.

impl<'a, S> From<&'a HttpRequest<S>> for HttpResponseBuilder

fn from(req: &'a HttpRequest<S>) -> HttpResponseBuilder

Converts to this type from the input type.

impl<S> FromRequest<S> for HttpRequest<S>

type Config = ()

Configuration for conversion process

type Result = HttpRequest<S>

Future that resolves to a Self

fn from_request(req: &HttpRequest<S>, _: &Self::Config) -> Self::Result

Convert request to a Self

fn extract(req: &HttpRequest<S>) -> Self::Result

Convert request to a Self

impl<S> HttpMessage for HttpRequest<S>

type Stream = Payload

Type of message payload stream

fn headers(&self) -> &HeaderMap

Read the message headers.

fn payload(&self) -> Payload

Message payload stream

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<EncodingRef, 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 body(&self) -> MessageBody<Self>

Load http message body.

fn urlencoded<T: DeserializeOwned>(&self) -> UrlEncoded<Self, T>

Parse application/x-www-form-urlencoded encoded request’s body. Return UrlEncoded future. Form can be deserialized to any type that implements Deserialize trait from serde.

fn json<T: DeserializeOwned>(&self) -> JsonBody<Self, T>

Parse application/json encoded body. Return JsonBody<T> future. It resolves to a T value.

fn multipart(&self) -> Multipart<Self::Stream>

Return stream to http payload processes as multipart.

fn readlines(&self) -> Readlines<Self>

Return stream of lines.

impl<S> RequestIdentity for HttpRequest<S>

fn identity(&self) -> Option<String>

Return the claimed identity of the user associated request or None if no identity can be found associated with the request.

fn remember(&self, identity: String)

Remember identity.

fn forget(&self)

This method is used to ‘forget’ the current identity on subsequent requests.

impl<S> RequestSession for HttpRequest<S>

fn session(&self) -> Session

Get the session from the request