Struct Query 

pub struct Query<T>(pub T);

Query string extractor

Parses the query string into type T.

Example

#[derive(Deserialize)]
struct Pagination {
    page: Option<u32>,
    limit: Option<u32>,
}

async fn list_users(Query(params): Query<Pagination>) -> impl IntoResponse {
    // params.page, params.limit
}

Tuple Fields

0: T

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> FromRequestParts for Query<T>

where T: DeserializeOwned,

fn from_request_parts(req: &Request) -> Result<Query<T>, ApiError>

Extract from request parts

impl<T> OperationModifier for Query<T>

where T: RustApiSchema,

fn update_operation(op: &mut Operation)

fn register_components(spec: &mut OpenApiSpec)

impl<T> RustApiSchema for Query<T>

where T: RustApiSchema,

fn schema(ctx: &mut SchemaCtx) -> SchemaRef

fn field_schemas(ctx: &mut SchemaCtx) -> Option<BTreeMap<String, SchemaRef>>

Get field schemas if this type is a struct (for Query params extraction)

fn component_name() -> Option<&'static str>

fn name() -> Cow<'static, str>

Get a unique name for this type, including generic parameters. Used for preventing name collisions in schema registry.