Struct poem_openapi::payload::Form

pub struct Form<T>(pub T);

A url encoded form payload.

Tuple Fields

0: T

Trait Implementations

impl<'a, T: DeserializeOwned + Type> ApiExtractor<'a> for Form<T>

const TYPE: ApiExtractorType = crate::ApiExtractorType::RequestObject

The type of API extractor.

type ParamType = ()

The parameter type.

type ParamRawType = ()

The raw parameter type for validators.

fn register(registry: &mut Registry)

Register related types to registry.

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.

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.

const PARAM_IS_REQUIRED: bool = false

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

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

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

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.

impl<T: Clone> Clone for Form<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Form<T>

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

Formats the value using the given formatter.

impl<T> Deref for Form<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Form<T>

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

Mutably dereferences the value.

impl<T: DeserializeOwned> ParsePayload for Form<T>

const IS_REQUIRED: bool = true

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

fn from_request<'life0, 'life1, 'async_trait>(
    req: &'life0 Request,
    body: &'life1 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Parse the payload object from the HTTP request.

impl<T: PartialEq> PartialEq<Form<T>> for Form<T>

fn eq(&self, other: &Form<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Type> Payload for Form<T>

const CONTENT_TYPE: &'static str = "application/x-www-form-urlencoded"

The content type of this payload.

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.

impl<T: Eq> Eq for Form<T>

impl<T> StructuralEq for Form<T>

impl<T> StructuralPartialEq for Form<T>