Struct LinoRequest 

pub struct LinoRequest {
    pub method: String,
    pub path: String,
    pub headers: Headers,
    pub params: PathParams,
    pub query_string: String,
    pub body: Option<LinoValue>,
    pub media_type: String,
    pub request_media_type: Option<String>,
    pub query_defaults: QueryDefaults,
}

One HTTP request, decoded according to the specification.

Fields

method: String

HTTP method, upper-cased.

path: String

Request path, without the query string.

headers: Headers

Request headers, looked up without regard to case.

params: PathParams

Path parameters captured by the matched route.

query_string: String

Raw query string, without its leading ?.

body: Option<LinoValue>

Decoded request body, or None when the request carried none.

media_type: String

The representation the response will be encoded as.

request_media_type: Option<String>

The media type the request body arrived in.

query_defaults: QueryDefaults

Page-size defaults inherited from the application.

Implementations

impl LinoRequest

pub fn new<M: Into<String>, P: Into<String>>(method: M, path: P) -> Self

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

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

Read a request header, case insensitively.

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

Read a path parameter, percent-decoded.

Examples

use lino_rest_api::request::LinoRequest;

let mut request = LinoRequest::new("GET", "/tasks/a%20b");
request.params.insert("id".to_string(), "a%20b".to_string());
assert_eq!(request.param("id").as_deref(), Some("a b"));

pub fn query(&self) -> QueryParams

Query parameters, with repeated parameters kept in order.

pub fn collection_query(&self) -> Result<CollectionQuery, LinoHttpError>

Parse the query string as a collection query (specification section 6).

Errors

A 400 when limit or offset is not a non-negative integer.

pub fn require_body(&self) -> Result<&LinoValue, LinoHttpError>

The request body, or a 400 when the request carried none.

Errors

A 400 when the body is absent, which is what a POST without one is.

pub fn instance(&self) -> String

The path together with its query string, as the instance of a problem.

Trait Implementations

impl Clone for LinoRequest

fn clone(&self) -> LinoRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinoRequest

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

Formats the value using the given formatter.