Trait poem_openapi::ApiResponse

pub trait ApiResponse: Sized {
    const BAD_REQUEST_HANDLER: bool = false;

    // Required methods
    fn meta() -> MetaResponses;
    fn register(registry: &mut Registry);

    // Provided method
    fn from_parse_request_error(err: Error) -> Self { ... }
}

Expand description

Represents a OpenAPI responses object.

§Provided Implementations

Binary<T: Type>

A binary response with content type application/octet-stream.
Json<T: Type>

A JSON response with content type application/json.
PlainText<T: Type>

A utf8 string response with content type text/plain.
Attachment<T: Type>

A file download response, the content type is application/octet-stream.
Response<T: Type>

A response type use it to modify the status code and HTTP headers.
()

It means that this API does not have any response body.
poem::Result<T: ApiResponse>

It means that an error may occur in this API.
Any type derived from the ApiResponse macro

A complex response derived from the ApiResponse macro.

Provided Associated Constants§

const BAD_REQUEST_HANDLER: bool = false

If true, it means that the response object has a custom bad request handler.

Required Methods§

fn meta() -> MetaResponses

Gets metadata of this response.

fn register(registry: &mut Registry)

Register the schema contained in this response object to the registry.

Provided Methods§

fn from_parse_request_error(err: Error) -> Self

Convert poem::Error to this response object.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

impl ApiResponse for StaticFileResponse

fn meta() -> MetaResponses

fn register(_registry: &mut Registry)

impl ApiResponse for ()

fn meta() -> MetaResponses

fn register(_registry: &mut Registry)

impl ApiResponse for Error

fn meta() -> MetaResponses

fn register(_registry: &mut Registry)

impl<F, Fut> ApiResponse for WebSocketUpgraded<F>
where F: FnOnce(WebSocketStream) -> Fut + Send + Sync + 'static, Fut: Future + Send + 'static,

fn meta() -> MetaResponses

fn register(_registry: &mut Registry)

impl<T, E> ApiResponse for Result<T, E>
where T: ApiResponse, E: ApiResponse + Into<Error> + Send + Sync + 'static,

const BAD_REQUEST_HANDLER: bool = T::BAD_REQUEST_HANDLER

fn meta() -> MetaResponses

fn register(registry: &mut Registry)

fn from_parse_request_error(err: Error) -> Self

Implementors§

impl<T: AsRef<[u8]> + Send> ApiResponse for Base64<T>

impl<T: Into<String> + Send> ApiResponse for Html<T>

impl<T: Into<String> + Send> ApiResponse for PlainText<T>

impl<T: Into<Body> + Send> ApiResponse for Attachment<T>

impl<T: Into<Body> + Send> ApiResponse for Binary<T>

impl<T: Stream<Item = E> + Send + 'static, E: Type + ToJSON> ApiResponse for EventStream<T>

impl<T: ApiResponse> ApiResponse for Response<T>

const BAD_REQUEST_HANDLER: bool = T::BAD_REQUEST_HANDLER

impl<T: ToJSON> ApiResponse for Json<T>

impl<T: ToXML> ApiResponse for Xml<T>

impl<T: ToYAML> ApiResponse for Yaml<T>