Struct poem_openapi::param::Query

pub struct Query<T>(pub T);

Represents the parameters passed by the query string.

Tuple Fields

0: T

Trait Implementations

impl<'a, T: ParseFromParameter> ApiExtractor<'a> for Query<T>

const TYPE: ApiExtractorType = ApiExtractorType::Parameter

The type of API extractor.

const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED

If it is true, it means that this parameter is required.

type ParamType = T

The parameter type.

type ParamRawType = <T as Type>::RawValueType

The raw parameter type for validators.

fn register(registry: &mut Registry)

Register related types to registry.

fn param_in() -> Option<MetaParamIn>

Returns the location of the parameter if this extractor is parameter.

fn param_schema_ref() -> Option<MetaSchemaRef>

Returns the schema of the parameter if this extractor is parameter.

fn param_raw_type(&self) -> Option<&Self::ParamRawType>

Returns a reference to the raw type of this parameter.

fn from_request<'life0, 'async_trait>( request: &'a Request, _body: &'life0 mut RequestBody, param_opts: ExtractParamOptions<Self::ParamType> ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Parse from the HTTP request.

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

Returns name of security scheme if this extractor is security scheme.

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.

impl<T> Deref for Query<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Query<T>

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

Mutably dereferences the value.