Struct Request 

pub struct Request { /* private fields */ }

An inbound HTTP request.

Implementations

impl Request

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

Build a request from its parts. The server calls this; tests should prefer Request::builder.

pub fn builder() -> RequestBuilder

A fluent builder, mainly for tests.

pub fn from_http(request: Request<Bytes>) -> Self

Adopt an http::Request whose body has already been buffered.

pub fn method(&self) -> &Method

The HTTP method.

pub fn uri(&self) -> &Uri

The full request URI.

pub fn path(&self) -> &str

The path, without the query string. Always begins with /.

pub fn query_string(&self) -> &str

The raw query string, without the ?.

pub fn version(&self) -> Version

The HTTP version.

pub fn headers(&self) -> &HeaderMap

Every header.

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

Mutable access to the headers — for middleware that normalises them.

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

One header as a string, or None if absent or not valid UTF-8.

pub fn set_method(&mut self, method: Method)

Replace the method.

For the one middleware that legitimately needs it: turning a browser form’s POST with _method=DELETE into a real DELETE before routing sees it. See MethodOverride — and note that it must run before the router, or the route has already been chosen for the old method.

pub fn is_method(&self, method: &Method) -> bool

Whether the method is method.

pub fn body(&self) -> &Bytes

The raw body bytes.

pub fn body_string(&self) -> String

The body as UTF-8, lossily.

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

The Content-Type header, lowercased and without parameters.

pub fn is_json(&self) -> bool

Whether the body claims to be JSON. Also true for +json suffixes such as application/ld+json.

pub fn expects_json(&self) -> bool

Whether the client would rather have JSON back.

True when it sent JSON, when it asked for JSON in Accept, or when it looks like an XHR. This is what the exception handler consults to decide between a JSON error body and an HTML error page.

pub fn query(&self) -> &Value

The query string parsed into a JSON tree.

pub fn body_input(&self) -> &Value

The body’s fields as a JSON tree — {} when there is no parseable body.

pub fn all(&self) -> Value

Every input: the query string with the body merged over it.

Route parameters are not included — they are part of the URL’s shape rather than user input, and mixing them in would let a query string shadow a route binding. Read them with route_param.

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

One input by dotted key, as a string. Body wins over query string.

pub fn transform_input(&mut self, transform: impl FnOnce(Value) -> Value)

Rewrite every input through transform.

The seam input-normalising middleware works through: TrimStrings and ConvertEmptyStringsToNull both take all, reshape it, and hand it back. Later reads see only the rewritten values.

pub fn set_input(&mut self, value: Value)

Replace every input outright.

pub fn merge_input(&mut self, extra: Value)

Merge extra values over the current inputs, for a middleware that resolves something the handler should read as ordinary input.

pub fn input_or(&self, key: &str, default: impl Into<String>) -> String

One input, or default.

pub fn input_value(&self, key: &str) -> Option<&Value>

The raw JSON value at key, for non-scalar inputs.

pub fn has(&self, key: &str) -> bool

Whether key is present at all (even if empty).

pub fn input_was_rewritten(&self) -> bool

Whether input-rewriting middleware has replaced the inputs.

pub fn filled(&self, key: &str) -> bool

Whether key is present and not empty.

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

Deserialise the JSON body into T.

Fails with a 400 when the body is absent, is not JSON, or does not fit T — unlike input, which shrugs at a bad body.

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

Deserialise the merged inputs into T.

Every value from a form or query string is a string, so T should either use string fields or #[serde(deserialize_with = ..)] coercions. For typed coercion from forms, validate instead.

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

Deserialise the query string into T.

pub fn files(&self, field: &str) -> &[UploadedFile]

Every file uploaded under field.

pub fn file(&self, field: &str) -> Option<&UploadedFile>

The first file uploaded under field.

pub fn has_file(&self, field: &str) -> bool

Whether a non-empty file arrived under field.

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

Every cookie the client sent.

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

One cookie’s value.

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

The Authorization: Bearer … token, if present.

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

A parameter captured by the matched route (/posts/{post}).

pub fn route_params(&self) -> &HashMap<String, String>

Every captured route parameter.

pub fn set_route_params(&mut self, params: HashMap<String, String>)

Replace the captured route parameters. The router calls this on match.

pub fn extensions(&self) -> &Extensions

Per-request attributes, keyed by type: the authenticated user, the matched route, a resolved model binding.

pub fn extensions_mut(&mut self) -> &mut Extensions

Mutable per-request attributes.

pub fn with_extension<T: Send + Sync + 'static>(self, value: T) -> Self

Store a per-request attribute, returning self for chaining.

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

Read a per-request attribute.

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

The client’s IP, if the server recorded one.

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.