Trait aide::operation::OperationOutput

pub trait OperationOutput {
    type Inner;

    // Provided methods
    fn operation_response(
        ctx: &mut GenContext,
        operation: &mut Operation
    ) -> Option<Response> { ... }
    fn inferred_responses(
        ctx: &mut GenContext,
        operation: &mut Operation
    ) -> Vec<(Option<u16>, Response)> { ... }
}

A trait for operation output schema generation.

This can be implemented for types that can describe their own output schema.

All method implementations are optional.

For simpler cases or wrappers the OperationIo derive macro can be used to implement this trait.

Required Associated Types

type Inner

The type that is used in examples.

Examples

In case of Json<T>, this should be T, whereas for String it should be Self.

Provided Methods

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

Return a response documentation for this type, alternatively modify the operation if required.

This method gets mutable access to the entire operation, it’s the implementer’s responsibility to detect errors and only modify the operation as much as needed.

Note that this function can be called multiple times for the same operation and should be idempotent.

There are reusable helpers in aide::operation to help with both boilerplate and error detection.

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

Inferred responses are used when the type is used as a request handler return type.

The function is supposed to return (status code, response) pairs, if the status code is not specified, the response is assumed to be a default response.

As an example Result<T, E> could return (Some(200), T::operation_response(..)) and (None, E::operation_response(..)) to indicate a successful response and a default error.

This function can be called after or before operation_response, it’s important for the implementation to be idempotent.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl OperationOutput for FormRejection

Available on crate feature axum only.

type Inner = FormRejection

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl OperationOutput for JsonRejection

Available on crate feature axum only.

type Inner = JsonRejection

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl OperationOutput for ()

type Inner = ()

fn operation_response( _ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl OperationOutput for String

type Inner = String

fn operation_response( _ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl OperationOutput for Vec<u8>

type Inner = Vec<u8>

fn operation_response( _ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl OperationOutput for PrivateCookieJar

Available on crate features axum-extra and axum and axum-extra-cookie-private only.

type Inner = ()

impl OperationOutput for CookieJar

Available on crate features axum-extra and axum and axum-extra-cookie only.

type Inner = ()

impl OperationOutput for Redirect

Available on crate feature axum only.

type Inner = Redirect

fn operation_response( _ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

impl OperationOutput for Bytes

Available on crate feature bytes only.

type Inner = Bytes

fn operation_response( _ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl OperationOutput for BytesMut

Available on crate feature bytes only.

type Inner = BytesMut

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl OperationOutput for StatusCode

Available on crate feature http only.

type Inner = StatusCode

impl<'a> OperationOutput for &'a str

type Inner = &'a str

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<'a> OperationOutput for &'a [u8]

type Inner = &'a [u8]

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<'a> OperationOutput for Cow<'a, str>

type Inner = Cow<'a, str>

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<'a> OperationOutput for Cow<'a, [u8]>

type Inner = Cow<'a, [u8]>

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<B> OperationOutput for Response<B>

Available on crate feature http only.

type Inner = Response<B>

impl<T1, T2> OperationOutput for (T1, T2)

type Inner = Infallible

impl<T1, T2, T3> OperationOutput for (T1, T2, T3)

type Inner = Infallible

impl<T1, T2, T3, T4> OperationOutput for (T1, T2, T3, T4)

type Inner = Infallible

impl<T1, T2, T3, T4, T5> OperationOutput for (T1, T2, T3, T4, T5)

type Inner = Infallible

impl<T1, T2, T3, T4, T5, T6> OperationOutput for (T1, T2, T3, T4, T5, T6)

type Inner = Infallible

impl<T1, T2, T3, T4, T5, T6, T7> OperationOutput for (T1, T2, T3, T4, T5, T6, T7)

type Inner = Infallible

impl<T1, T2, T3, T4, T5, T6, T7, T8> OperationOutput for (T1, T2, T3, T4, T5, T6, T7, T8)

type Inner = Infallible

impl<T1, T2, T3, T4, T5, T6, T7, T8, T9> OperationOutput for (T1, T2, T3, T4, T5, T6, T7, T8, T9)

type Inner = Infallible

impl<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> OperationOutput for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

type Inner = Infallible

impl<T> OperationOutput for Option<T>

where T: OperationOutput,

type Inner = <T as OperationOutput>::Inner

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<T> OperationOutput for Box<T>

where T: OperationOutput,

type Inner = <T as OperationOutput>::Inner

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<T> OperationOutput for Rc<T>

where T: OperationOutput,

type Inner = <T as OperationOutput>::Inner

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<T> OperationOutput for Arc<T>

where T: OperationOutput,

type Inner = <T as OperationOutput>::Inner

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<T> OperationOutput for Form<T>

where T: JsonSchema,

Available on crate feature axum only.

type Inner = T

fn operation_response( ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<T> OperationOutput for Json<T>

where T: JsonSchema,

Available on crate feature axum only.

type Inner = T

fn operation_response( ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<T> OperationOutput for Html<T>

Available on crate feature axum only.

type Inner = String

fn operation_response( _ctx: &mut GenContext, _operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

impl<T, E> OperationOutput for Result<T, E>

where T: OperationOutput, E: OperationOutput,

type Inner = T

fn operation_response( ctx: &mut GenContext, operation: &mut Operation ) -> Option<Response>

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

Implementors

impl<T> OperationOutput for NoApi<T>

type Inner = ()

impl<T> OperationOutput for WithApi<T>

where T: OperationOutput + ApiOverride,

type Inner = <T as OperationOutput>::Inner

impl<T, A> OperationOutput for UseApi<T, A>

where A: OperationOutput,

type Inner = <A as OperationOutput>::Inner