Skip to main content

LinoRequest

Struct LinoRequest 

Source
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,
}
Expand description

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§

Source§

impl LinoRequest

Source

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.

Source

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

Read a request header, case insensitively.

Source

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"));
Source

pub fn query(&self) -> QueryParams

Query parameters, with repeated parameters kept in order.

Source

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.

Source

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.

Source

pub fn instance(&self) -> String

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

Trait Implementations§

Source§

impl Clone for LinoRequest

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinoRequest

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more