Struct RequestView 

#[non_exhaustive]
pub struct RequestView<'a> {
    pub method: Cow<'a, str>,
    pub path: Cow<'a, str>,
    pub query: Option<Cow<'a, str>>,
    pub headers: Vec<(Cow<'a, str>, Cow<'a, str>)>,
    pub body: Option<Cow<'a, [u8]>>,
}

One HTTP request, as much of it as an OpenAPI description describes.

Built directly, or from a framework’s own request type through ToRequestView:

use roas_http_validator::RequestView;

let request = RequestView::new("GET", "/pets/7")
    .with_query("limit=10")
    .with_header("accept", "application/json");

assert_eq!(request.header("Accept"), Some("application/json"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

method: Cow<'a, str>

The HTTP method, as the request carried it.

Matched case-sensitively, as RFC 9110 §9.1 requires of a method token: GET finds the get a Path Item Object keys it under, and get finds nothing.

path: Cow<'a, str>

The path, without the query string. Percent-encoding is kept as it arrived — a %2F in a path parameter is not a separator, and decoding here would make it one.

query: Option<Cow<'a, str>>

The raw query string, without the leading ?.

headers: Vec<(Cow<'a, str>, Cow<'a, str>)>

Headers in the order they arrived, names as written. A header may repeat, so this is a list rather than a map.

body: Option<Cow<'a, [u8]>>

The body, already buffered.

None means no body was supplied; Some(&[]) means one was and it was empty. Validation keeps them apart — an empty JSON body is malformed where an absent optional one is fine — so a caller that means “no body” leaves this None rather than passing no bytes.

Implementations

impl<'a> RequestView<'a>

pub fn new( method: impl Into<Cow<'a, str>>, path: impl Into<Cow<'a, str>>, ) -> Self

A request with a method and a path and nothing else.

pub fn with_query(self, query: impl Into<Cow<'a, str>>) -> Self

Set the query string. A leading ? is accepted and dropped, so both halves of uri.query() and "?" + query work.

pub fn with_header( self, name: impl Into<Cow<'a, str>>, value: impl Into<Cow<'a, str>>, ) -> Self

Add one header. Repeating a name adds a second value rather than replacing the first.

pub fn with_headers<N, V>( self, headers: impl IntoIterator<Item = (N, V)>, ) -> Self

where N: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Add many headers at once.

pub fn with_body(self, body: impl Into<Cow<'a, [u8]>>) -> Self

Supply the buffered body.

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

The first value of name, matched case-insensitively as RFC 9110 §5.1 requires.

pub fn header_values<'s>( &'s self, name: &'s str, ) -> impl Iterator<Item = &'s str> + 's

Every value of name, in order.

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

The media type from Content-Type, lowercased, with any parameters (; charset=utf-8) dropped.

pub fn query_pairs(&self) -> Vec<(String, String)>

The query string decoded into name/value pairs, keeping order and repeats — ?tag=a&tag=b is two pairs, not one.

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

The cookies from the Cookie header, in the order sent.

Trait Implementations

impl<'a> Clone for RequestView<'a>

fn clone(&self) -> RequestView<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for RequestView<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RequestView<'a>

fn default() -> RequestView<'a>

Returns the “default value” for a type.

impl<'a> Eq for RequestView<'a>

impl<'a> PartialEq for RequestView<'a>

fn eq(&self, other: &RequestView<'a>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for RequestView<'a>