Struct actix_web::Request

[+] Show declaration

pub struct Request { /* fields omitted */ }

[−] Expand description

Request's context

Methods

impl 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 headers_mut(&mut self) -> &mut HeaderMap

[−]

Returns mutable 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 server_settings(&self) -> &ServerSettings

[−]

Server settings

Trait Implementations

impl HttpMessage for Request

[+]

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.