Trait gotham_restful::ResponseSchema

source · 
pub trait ResponseSchema {
    // Required method
    fn schema(code: StatusCode) -> OpenapiSchema;

    // Provided method
    fn status_codes() -> Vec<StatusCode> { ... }
}
Expand description

Additional details for IntoResponse to be used with an OpenAPI-aware router.

Required Methods§

source

fn schema(code: StatusCode) -> OpenapiSchema

Return the schema of the response for the given status code. The code may only be one that was previously returned by Self::status_codes. The implementation should panic if that is not the case.

Provided Methods§

source

fn status_codes() -> Vec<StatusCode>

All status codes returned by this response. Returns [StatusCode::OK] by default.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl<E> ResponseSchema for Result<NoContent, E>
where E: Debug + IntoResponseError<Err = Error>,

source§

fn status_codes() -> Vec<StatusCode>

source§

fn schema(code: StatusCode) -> OpenapiSchema

source§

impl<E> ResponseSchema for Result<Redirect, E>
where E: Debug + IntoResponseError, <E as IntoResponseError>::Err: StdError + Sync,

source§

fn status_codes() -> Vec<StatusCode>

source§

fn schema(code: StatusCode) -> OpenapiSchema

source§

impl<R, E> ResponseSchema for Result<R, E>
where R: ResponseBody, E: Debug + IntoResponseError<Err = Error>,

source§

fn status_codes() -> Vec<StatusCode>

source§

fn schema(code: StatusCode) -> OpenapiSchema

source§

impl<Res> ResponseSchema for Pin<Box<dyn Future<Output = Res> + Send>>
where Res: ResponseSchema,

source§

fn status_codes() -> Vec<StatusCode>

source§

fn schema(code: StatusCode) -> OpenapiSchema

source§

impl<T, E> ResponseSchema for Result<Raw<T>, E>
where Raw<T>: IntoResponseWithSchema, E: Debug + IntoResponseError<Err = <Raw<T> as IntoResponse>::Err>,

source§

fn status_codes() -> Vec<StatusCode>

source§

fn schema(code: StatusCode) -> OpenapiSchema

Implementors§