# [−][src]Struct actix_web::server::Request

    pub struct Request { /* fields omitted */ }

Request's context

## Methods

###

`impl Request`

[src]

####

`pub fn uri(&self) -> &Uri`

[src]

Read the Request Uri.

####

`pub fn method(&self) -> &Method`

[src]

Read the Request method.

####

`pub fn version(&self) -> Version`

[src]

Read the Request Version.

####

`pub fn path(&self) -> &str`

[src]

The target path of this Request.

####

`pub fn headers(&self) -> &HeaderMap`

[src]

Returns Request's headers.

####

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

[src]

Returns mutable Request's headers.

####

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

[src]

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`

[src]

Checks if a connection should be kept alive.

####

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

[src]

Check if request requires connection upgrade

####

`pub fn connection_info(&self) -> Ref<ConnectionInfo>`

[src]

Get ConnectionInfo for the correct request.

####

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

[src]

Io stream extensions

####

`pub fn server_settings(&self) -> &ServerSettings`

[src]

Server settings

## Trait Implementations

###

`impl HttpMessage for Request`

[src]

#### `type Stream = Payload`

Type of message payload stream

####

`fn headers(&self) -> &HeaderMap`

[src]

Read the message headers.

####

`fn payload(&self) -> Payload`

[src]

Message payload stream

####

`fn content_type(&self) -> &str`

[src]

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

####

`fn encoding(&self) -> Result<EncodingRef, ContentTypeError>`

[src]

Get content type encoding Read more

####

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

[src]

Convert the request content type to a known mime type.

####

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

[src]

Check if request has chunked transfer encoding

####

`fn body(&self) -> MessageBody<Self>`

[src]

Load http message body. Read more

####

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

[src]

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. Read more

####

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

[src]

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

####

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

[src]

Return stream to http payload processes as multipart. Read more

####

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

[src]

Return stream of lines.

###

`impl Debug for Request`

[src]

####

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

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl !Send for Request`

###

`impl !Sync for Request`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id`)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)