Trait poem_openapi::payload::Payload

pub trait Payload: Sized {
    const CONTENT_TYPE: &'static str;

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

    fn register(registry: &mut Registry) { ... }
}

Represents a payload type.

Associated Constants

const CONTENT_TYPE: &'static str

The content type of this payload.

Required methods

fn schema_ref() -> MetaSchemaRef

Gets schema reference of this payload.

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

Parse the payload object from the HTTP request.

Provided methods

fn register(registry: &mut Registry)

Register the schema contained in this payload to the registry.

Implementations on Foreign Types

impl<T: Payload> Payload for Result<T>

const CONTENT_TYPE: &'static str

fn schema_ref() -> MetaSchemaRef

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

Implementors

impl Payload for Binary

const CONTENT_TYPE: &'static str

impl Payload for PlainText

const CONTENT_TYPE: &'static str

impl<T: ParseFromJSON> Payload for Json<T>

const CONTENT_TYPE: &'static str