Struct poem_openapi::param::Query

source · [−]

pub struct Query<T>(pub T);

Expand description

Represents the parameters passed by the query string.

Tuple Fields

0: T

Trait Implementations

source

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

source

const TYPE: ApiExtractorType

The type of API extractor.

source

const PARAM_IS_REQUIRED: bool

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

type ParamType = T

The parameter type.

type ParamRawType = T::RawValueType

The raw parameter type for validators.

source

fn register(registry: &mut Registry)

Register related types to registry.

source

fn param_in() -> Option<MetaParamIn>

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

source

fn param_schema_ref() -> Option<MetaSchemaRef>

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

source

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

Returns a reference to the raw type of this parameter.

source

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
 'a: 'async_trait,
 'life0: 'async_trait,
 Self: 'async_trait,

Parse from the HTTP request.

source

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

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

source

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.

source

impl<T> Deref for Query<T>

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.

Auto Trait Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V

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

Struct poem_openapi::param::Query

Tuple Fields

Trait Implementations

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

const TYPE: ApiExtractorType

const PARAM_IS_REQUIRED: bool

type ParamType = T

type ParamRawType = T::RawValueType

fn register(registry: &mut Registry)

fn param_in() -> Option<MetaParamIn>

fn param_schema_ref() -> Option<MetaSchemaRef>

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

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 'a: 'async_trait, 'life0: 'async_trait, Self: 'async_trait,

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

fn request_meta() -> Option<MetaRequest>

impl<T> Deref for Query<T>

type Target = T

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

impl<T> DerefMut for Query<T>

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

Auto Trait Implementations

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

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Formattable for T where T: Deref, <T as Deref>::Target: Formattable,

impl<T> Parsable for T where T: Deref, <T as Deref>::Target: Parsable,

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
'a: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,

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,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Formattable for T where
T: Deref,
<T as Deref>::Target: Formattable,

impl<T> Parsable for T where
T: Deref,
<T as Deref>::Target: Parsable,