Struct Request 

pub struct Request { /* private fields */ }

An incoming request, already parsed and matched against a route.

Implementations

impl Request

pub fn new(method: Method, target: impl Into<String>) -> Self

Build a request directly. This is what the test client and the server parser both go through.

pub fn method(&self) -> Method

pub fn path(&self) -> &str

The path with no query string: /users/7.

pub fn target(&self) -> &str

The raw request target, query string included.

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

The pattern this request matched: /users/{id}. Useful for metrics that must not explode into one series per id.

pub fn headers(&self) -> &Headers

pub fn headers_mut(&mut self) -> &mut Headers

pub fn header(&self, name: &str) -> Option<&str>

pub fn body(&self) -> &[u8]

pub fn body_string(&self) -> String

pub fn context(&self) -> &Context

pub fn config(&self) -> &Config

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

A service registered on the application: req.state::<Database>().

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

pub fn ip(&self) -> Option<String>

The client IP, honouring X-Forwarded-For when behind a proxy. The client’s address.

The address that opened the socket, unless TrustProxies ran and the connection came from a proxy on its list — then it is the client address that proxy reported.

It deliberately does not read X-Forwarded-For on its own. A header is something any client can send, so believing one unconditionally does not reveal the client’s address, it lets the client choose one — and everything keyed on this, the rate limiter included, would be defeated by a header.

pub fn scheme(&self) -> &str

https when a trusted proxy said the client used TLS, or the connection itself did; http otherwise.

A proxy that terminates TLS forwards a plain request, so without this an application behind one would build http:// links for a site that is entirely https://.

pub fn is_secure(&self) -> bool

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

The Host a trusted proxy said the client asked for.

pub fn forwarded_port(&self) -> Option<u16>

The port a trusted proxy said the client connected to.

pub fn param(&self, name: &str) -> Option<&str>

A route parameter: for /users/{id} matching /users/7, param("id") is "7".

pub fn param_as<T: FromStr>(&self, name: &str) -> Option<T>

A route parameter parsed into a type, so a handler can ask for an id as a number without unwrapping twice.

pub fn params(&self) -> &BTreeMap<String, String>

pub fn query(&self, name: &str) -> Option<&str>

pub fn query_all(&self, name: &str) -> Vec<&str>

Every value for a repeated query key: ?tag=a&tag=b.

pub fn query_pairs(&self) -> &[(String, String)]

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

pub fn is_json(&self) -> bool

pub fn wants_json(&self) -> bool

Whether the client wants JSON back — an API client or a fetch() call.

pub fn json(&mut self) -> Option<&Json>

The body parsed as JSON, or None if it is absent or malformed.

pub fn input(&mut self, name: &str) -> Option<String>

One input value, looked up in the JSON body, then the form body, then the query string — the resolution order of Laravel’s $request->input().

pub fn inputs(&mut self, name: &str) -> Vec<String>

All decoded form fields of a application/x-www-form-urlencoded body. Every value submitted under one name.

A form with several checkboxes sharing a name — roles[], which is how PHP and every HTML tutorial spell it — sends the name once per ticked box. Request::input returns only the first, which for a checkbox group silently means “whichever happened to come first”.

A trailing [] is optional here: inputs("roles") and inputs("roles[]") both find them, because which one a form used is a detail of the markup rather than a decision the handler should have to track.

pub fn form(&mut self) -> &[(String, String)]

pub fn cookies(&self) -> BTreeMap<String, String>

pub fn cookie(&self, name: &str) -> Option<String>

pub fn extend<T: Send + Sync + 'static>(&mut self, value: T)

Attach a value for later middleware or the handler to read.

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

The API version this request is for — from the route’s Router::version group, or from the VersionHeader middleware.

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

The identifier the RequestId middleware assigned, for log lines and error reports.

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

Read a value attached by earlier middleware.

pub fn with_peer(self, peer: SocketAddr) -> Self

Set the address the request arrived from, as the server does.

pub fn with_header(self, name: &str, value: impl Into<String>) -> Self

pub fn with_body(self, body: impl Into<Vec<u8>>) -> Self

pub fn with_json(self, value: Json) -> Self

pub fn with_form(self, fields: &[(&str, &str)]) -> Self

pub fn with_context(self, context: Context) -> Self

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.