Struct pavex::request::query::QueryParams

source ·
pub struct QueryParams<T>(pub T);
Expand description

Extract (typed) query parameters from the query of an incoming request.

§Guide

Check out the guide for more information on how to use this extractor.

§Example

use pavex::request::query::QueryParams;
// You must derive `serde::Deserialize` for the type you want to extract,
// in this case `Home`.
#[derive(serde::Deserialize)]
pub struct Home {
    home_id: u32
}

// The `QueryParams` extractor deserializes the extracted query parameters into
// the type you specified—`Home` in this case.
pub fn get_home(params: &QueryParams<Home>) -> String {
   format!("The identifier for this home is: {}", params.0.home_id)
}

The home_id field will be set to 1 for the ?home_id=1 query string.

Tuple Fields§

§0: T

The extracted query parameters, deserialized into T, the type you specified.

Implementations§

source§

impl<T> QueryParams<T>

source

pub fn extract<'request>( request_head: &'request RequestHead, ) -> Result<Self, ExtractQueryParamsError>
where T: Deserialize<'request>,

The default constructor for QueryParams.

If the extraction fails, an ExtractQueryParamsError is returned.

Check out QueryParams for more information on query parameters.

source§

impl QueryParams<()>

Auto Trait Implementations§

§

impl<T> Freeze for QueryParams<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for QueryParams<T>
where T: RefUnwindSafe,

§

impl<T> Send for QueryParams<T>
where T: Send,

§

impl<T> Sync for QueryParams<T>
where T: Sync,

§

impl<T> Unpin for QueryParams<T>
where T: Unpin,

§

impl<T> UnwindSafe for QueryParams<T>
where T: UnwindSafe,

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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