Struct Query 

pub struct Query<T>(pub T);

Available on (crate features minimal or standard or di) and non-WebAssembly only.

Extract query parameters from the URL

With the multi-value-arrays feature (enabled by default), repeated query parameters are properly parsed into vectors. For example, ?q=5&q=6 will be parsed as vec![5, 6] when the target field type is Vec<T>.

Example

use reinhardt_di::params::Query;
#[derive(Deserialize)]
struct Pagination {
    page: Option<i32>,
    per_page: Option<i32>,
}

let pagination = Pagination { page: Some(2), per_page: Some(25) };
let query = Query(pagination);
let page = query.page.unwrap_or(1);
let per_page = query.per_page.unwrap_or(10);
assert_eq!(page, 2);
assert_eq!(per_page, 25);

Multi-value Parameters

use reinhardt_di::params::Query;
#[derive(Deserialize)]
struct SearchQuery {
    q: Vec<i64>,  // Supports repeated keys: ?q=5&q=6
}

let search = SearchQuery { q: vec![5, 6] };
let query = Query(search);
assert_eq!(query.q, vec![5, 6]);

Tuple Fields

0: T

Implementations

impl<T> Query<T>

pub fn into_inner(self) -> T

Available on crate feature di only.

Unwrap the Query and return the inner value

Examples

use reinhardt_di::params::Query;
use serde::Deserialize;

#[derive(Deserialize, Debug, PartialEq)]
struct Pagination {
    page: i32,
    per_page: i32,
}

let query = Query(Pagination { page: 1, per_page: 10 });
let inner = query.into_inner();
assert_eq!(inner.page, 1);
assert_eq!(inner.per_page, 10);

Trait Implementations

impl<T> Clone for Query<T>

where T: Clone,

fn clone(&self) -> Query<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Query<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for Query<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Query<T> as Deref>::Target

Dereferences the value.

impl<T> FromRequest for Query<T>

where T: DeserializeOwned + Send,

fn from_request<'life0, 'life1, 'async_trait>( req: &'life0 Request, _ctx: &'life1 ParamContext, ) -> Pin<Box<dyn Future<Output = Result<Query<T>, ParamError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Query<T>: 'async_trait,

Extract this type from the request

impl<T> WithValidation for Query<T>

Available on non-crate feature validation only.

fn min_length(self, min: usize) -> ValidationConstraints<Self>

Creates a ValidationConstraints wrapper with a minimum length.

fn max_length(self, max: usize) -> ValidationConstraints<Self>

Creates a ValidationConstraints wrapper with a maximum length.

fn min_value<V>(self, min: V) -> ValidationConstraints<Self>

where V: ToString,

Creates a ValidationConstraints wrapper with a minimum value.

fn max_value<V>(self, max: V) -> ValidationConstraints<Self>

where V: ToString,

Creates a ValidationConstraints wrapper with a maximum value.

fn regex(self, pattern: impl Into<String>) -> ValidationConstraints<Self>

Creates a ValidationConstraints wrapper with a regex pattern.

fn email(self) -> ValidationConstraints<Self>

Creates a ValidationConstraints wrapper with email format validation.

fn url(self) -> ValidationConstraints<Self>

Creates a ValidationConstraints wrapper with URL format validation.