Trait OpenApiResponderInner 

pub trait OpenApiResponderInner {
    // Required method
    fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>;
}

Implementing this trait means that any route returning the implementer can be marked with #[openapi], and that the route can be documented.

Required Methods

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

Create the responses type, which is a list of responses that can be rendered in openapi.json format.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl OpenApiResponderInner for &str

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for &[u8]

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for Value

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for ()

fn responses(_: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for String

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for Vec<u8>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for File

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for Error

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for NamedFile

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for Redirect

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for NoContent

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for Status

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for File

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<'r, 'o, L, R> OpenApiResponderInner for Either<L, R>

where L: OpenApiResponderInner, R: OpenApiResponderInner,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<'r, 'o, T, E> OpenApiResponderInner for Result<T, E>

where T: OpenApiResponderInner, E: OpenApiResponderInner,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<'r, 'o: 'r, T> OpenApiResponderInner for Cow<'o, T>

where T: OpenApiResponderInner + Clone,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<E> OpenApiResponderInner for Debug<E>

where E: Debug,

Debug prints the internal value before forwarding to the 500 error catcher.

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl<R> OpenApiResponderInner for Capped<R>

where R: OpenApiResponderInner,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<R> OpenApiResponderInner for Flash<R>

where R: OpenApiResponderInner,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<R: OpenApiResponderInner> OpenApiResponderInner for (ContentType, R)

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<R: OpenApiResponderInner> OpenApiResponderInner for (Status, R)

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<S> OpenApiResponderInner for ByteStream<S>

where S: Send,

ByteStream is a (potentially infinite) responder. The response Content-Type is set to Binary. The body is unsized, and values are sent as soon as they are yielded by the internal iterator.

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<S> OpenApiResponderInner for ReaderStream<S>

where S: Send + Stream,

ReaderStream is a (potentially infinite) responder. No Content-Type is set. The body is unsized, and values are sent as soon as they are yielded by the internal iterator.

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl<S> OpenApiResponderInner for EventStream<S>

EventStream is a (potentially infinite) responder. The response Content-Type is set to EventStream. The body is unsized, and values are sent as soon as they are yielded by the internal iterator.

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl<S> OpenApiResponderInner for TextStream<S>

where S: Send,

TextStream is a (potentially infinite) responder. The response Content-Type is set to Text. The body is unsized, and values are sent as soon as they are yielded by the internal iterator.

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Accepted<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for BadRequest<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Conflict<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Created<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Custom<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Forbidden<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for NotFound<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Unauthorized<T>

where T: OpenApiResponderInner + Send,

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: Serialize + JsonSchema + Send> OpenApiResponderInner for Json<T>

Serializes the wrapped value into JSON. Returns a response with Content-Type JSON and a fixed-size body with the serialized value. If serialization fails, an Err of Status::InternalServerError is returned.

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for Option<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for RawCss<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for RawHtml<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for RawJavaScript<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for RawJson<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for RawMsgPack<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for RawText<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for RawXml<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

Implementors