Skip to main content

Query

Struct Query 

Source
pub struct Query<T>(pub T);
Expand description

Query string extractor.

Extracts and deserializes query string parameters into a typed struct. This extractor uses serde for deserialization, so the target type must implement DeserializeOwned.

§Features

  • Optional fields: Use Option<T> for optional parameters
  • Multi-value: Use Vec<T> for parameters that appear multiple times
  • Default values: Use #[serde(default)] for default values
  • Percent-decoding: Values are automatically percent-decoded

§Example

use fastapi_core::Query;
use serde::Deserialize;

#[derive(Deserialize)]
struct SearchParams {
    q: String,                      // Required
    page: Option<i32>,              // Optional
    #[serde(default)]
    limit: i32,                     // Default (0)
    tags: Vec<String>,              // Multi-value: ?tags=a&tags=b
}

#[get("/search")]
async fn search(cx: &Cx, params: Query<SearchParams>) -> impl IntoResponse {
    // Access the inner value via params.0 or *params
    let query = &params.q;
    // ...
}

§Error Handling

Returns HTTP 422 (Unprocessable Entity) when:

  • Required fields are missing
  • Type conversion fails (e.g., “abc” to i32)
  • Serde deserialization fails

Tuple Fields§

§0: T

Implementations§

Source§

impl<T> Query<T>

Source

pub fn new(value: T) -> Self

Create a new Query extractor with the given value.

Source

pub fn into_inner(self) -> T

Consume the extractor and return the inner value.

Trait Implementations§

Source§

impl<T: Clone> Clone for Query<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Query<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Default> Default for Query<T>

Source§

fn default() -> Query<T>

Returns the “default value” for a type. Read more
Source§

impl<T> Deref for Query<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<T> DerefMut for Query<T>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<T: DeserializeOwned> FromRequest for Query<T>

Source§

type Error = QueryExtractError

Error type when extraction fails.
Source§

async fn from_request( _ctx: &RequestContext, req: &mut Request, ) -> Result<Self, Self::Error>

Extract a value from the request. Read more
Source§

impl<T: Copy> Copy for Query<T>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for Query<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> 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> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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 = 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.
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
Source§

impl<T> ResponseProduces<T> for T