Struct Request 

pub struct Request {
    pub method: Method,
    pub uri: Uri,
    pub headers: HeaderMap,
    pub body: Bytes,
    pub params: Params,
    pub query: Query,
    pub extensions: Extensions,
    pub remote_addr: Option<SocketAddr>,
    pub matched_path: Option<Arc<str>>,
    pub secure: bool,
    /* private fields */
}

HTTP Request wrapper

Fields

method: Method

uri: Uri

headers: HeaderMap

body: Bytes

params: Params

query: Query

extensions: Extensions

Typed per-request data; middleware can attach values for handlers (authenticated user, request id, …).

remote_addr: Option<SocketAddr>

Address of the connected peer (the proxy when behind one)

matched_path: Option<Arc<str>>

The route pattern that matched, e.g. /users/{id}; None when no route matched. Use it, not the raw path, as a metrics label or log field: it stays the same for every id.

secure: bool

The request arrived over TLS (App::tls). Behind a TLS-terminating proxy this is false; see secure::RequireHttps::trust_forwarded_proto.

Implementations

impl Request

pub fn multipart(&self) -> Result<Multipart>

Parse a multipart/form-data body with the default MultipartLimits

415 for other content types, 400 for malformed bodies.

pub fn multipart_with(&self, limits: &MultipartLimits) -> Result<Multipart>

impl Request

pub fn request_id(&self) -> Option<&str>

Id assigned by RequestIdLayer, if installed

impl Request

pub fn new(method: Method, uri: Uri, headers: HeaderMap, body: Bytes) -> Self

pub fn accepts<'a>(&self, offered: &[&'a str]) -> Option<&'a str>

Which of offered media types the client prefers according to Accept (None when it accepts none of them), see crate::negotiate

pub fn accepts_language<'a>(&self, offered: &[&'a str]) -> Option<&'a str>

Which of offered languages the client prefers according to Accept-Language

pub fn body_stream(&mut self) -> Result<BodyStream>

The body as a stream, see crate::upload. On routes registered with App::stream_body nothing was buffered; on other routes the already buffered body is served as a single chunk, so a handler works either way. The stream can be taken once.

pub fn is_secure(&self) -> bool

True when the request came in over TLS

pub fn csp_nonce(&self) -> Option<&str>

Nonce for inline scripts and styles, when the SecurityHeaders policy uses the {nonce} placeholder

pub fn client_certificate(&self) -> Option<&[u8]>

DER of the leaf certificate the client presented during the TLS handshake (mutual TLS, feature tls); None for anonymous clients and plain HTTP. The certificate has already been verified against the CAs given to TlsConfig::client_auth; check which verified client it is (fingerprint or subject) before authorizing anything.

pub fn state<T: Send + Sync + 'static>(&self) -> Result<&T>

Shared application state registered with App::state

Answers 500 when no value of type T was registered: that is a programming error, not something the client can fix.

pub fn shutdown_signal(&self) -> Shutdown

Signal that fires when the server begins shutting down

Long-lived handlers (SSE streams, polling loops) select on it to end promptly: tokio::select! { _ = req.shutdown_signal().wait() => break, ... }.

pub fn state_arc<T: Send + Sync + 'static>(&self) -> Result<Arc<T>>

An owned handle to the same state, for when the value must outlive a borrow of the request (it is moved into middleware next.run(req), a spawned task, …)

pub fn try_state<T: Send + Sync + 'static>(&self) -> Option<&T>

Like Request::state, None when the type is not registered

pub fn cookies(&self) -> &Cookies

Get cookies from the request

pub fn form<T: DeserializeOwned>(&self) -> Result<T>

Parse an application/x-www-form-urlencoded body into a struct

Answers 415 for other content types and 400 for values that do not fit the target type.

pub fn form_data(&self) -> Result<Query>

The same body as decoded key/value access (+ and %XX decoded)

pub fn json<T: DeserializeOwned>(&self) -> Result<T>

Parse JSON body

impl Request

pub fn session(&self) -> Result<&Session>

The session of this request (needs the SessionLayer middleware; answers 500 otherwise)

impl Request

pub fn trace(&self) -> Option<&TraceContext>

Trace ids assigned by TraceLayer, if installed