Struct OpenApiHandlerImpl 

pub struct OpenApiHandlerImpl<Context> { /* private fields */ }

Interprets typed HTTP programs as the OpenAPI document that describes them.

Nothing is applied. Every endpoint is read for what a caller would have to state and what it would be answered with, which is why this interpretation asks for shapes where the others ask for extractors.

Implementations

impl<Context> OpenApiHandlerImpl<Context>

pub fn new() -> Self

Describes a surface, naming shapes where an OpenAPI document keeps them.

pub fn document( &self, title: &str, version: &str, route: &OpenApiRoute, ) -> Value

Returns the whole document for a surface, under a title and a version.

Trait Implementations

impl<Context> BytesOutAlg for OpenApiHandlerImpl<Context>

type Bytes<From> = OpenApiBytesOutput

The raw-byte converter selected for From.

impl<Context> Default for OpenApiHandlerImpl<Context>

fn default() -> Self

Returns the “default value” for a type.

impl<Context> EmptyOutAlg for OpenApiHandlerImpl<Context>

type Empty<From> = OpenApiEmptyOutput

The empty converter selected for From.

impl<Context> FileOutAlg for OpenApiHandlerImpl<Context>

type File<From> = OpenApiFileOutput

The streamed-file converter selected for From.

impl<Context> HandlerAlg for OpenApiHandlerImpl<Context>

type Endpoint = OpenApiEndpoint

The interpreter’s homogeneous endpoint representation.

impl<Context> HandlerContextAlg<Context> for OpenApiHandlerImpl<Context>

where Context: Send + Sync + 'static,

type Handle = Arc<Context>

The owned carrier cloned into asynchronous operation invocations.

impl<Context, Inputs, Args, Transform, Answering, Output> HandlerEndpointAlg<Arc<Context>, Inputs, Args, Transform, Output> for OpenApiHandlerImpl<Context>

where Context: Send + Sync + 'static, Inputs: OpenApiInputsAlg, Transform: OutputKindAlg<Self, Output, Transform = Answering>, Answering: OpenApiOutputAlg<Output>,

fn finish_handler<Handler>( &self, _handler: Handler, ) -> <Self as HandlerAlg>::Endpoint

where Handler: OperationAlg + ApplyAlg<Arc<Context>, Args, Output = Output> + Send + Sync + 'static,

Interprets a typed first-order handler as a concrete endpoint.

impl<Context> HeaderOutAlg for OpenApiHandlerImpl<Context>

type Header<Inner, Name> = OpenApiHeaderOutput<Inner, Name>

The converter writing Name beside the body Inner states.

impl<Context> HtmlOutAlg for OpenApiHandlerImpl<Context>

type Html<From> = OpenApiHtmlOutput

The HTML converter selected for From.

impl<Context> HttpInputAlg for OpenApiHandlerImpl<Context>

type Path<I> = OpenApiPathInput<I>

The interpreter’s path extractor for Input.

type Query<I> = OpenApiQueryInput<I>

The interpreter’s query extractor for Input.

type Body<I> = OpenApiBodyInput<I>

The interpreter’s request-body extractor for Input.

type Form<I> = OpenApiFormInput<I>

The interpreter’s form-encoded request-body extractor for Input.

type Multipart<I> = OpenApiMultipartInput<I>

The interpreter’s extractor for Input read from a body arriving as parts.

type RawBody<I> = OpenApiRawBodyInput<I>

The interpreter’s unread request-body extractor for Input.

type Header<I> = OpenApiHeaderInput<I>

The interpreter’s header extractor for Input.

type Cookie<I> = OpenApiCookieInput<I>

The interpreter’s cookie extractor for Input.

type Auth<I> = OpenApiHeaderInput<I>

The interpreter’s authentication extractor for Input.

type Context<I> = OpenApiUnstatedInput<I>

The interpreter’s endpoint-context extractor for Input.

impl<Context> HttpSelectorAlg for OpenApiHandlerImpl<Context>

type Selector = OpenApiSelector

The interpreter’s HTTP selector representation.

fn http_method(&self, method: HttpMethod) -> Self::Selector

Interprets a request-method selector.

fn http_path(&self, path: &RoutePath) -> Self::Selector

Interprets an exact path selector.

fn http_prefix(&self, prefix: &RoutePath) -> Self::Selector

Interprets a path-prefix selector.

impl<Context> JsonOutAlg for OpenApiHandlerImpl<Context>

type Json<From> = OpenApiJsonOutput

The JSON converter selected for From.

impl<Context> RedirectOutAlg for OpenApiHandlerImpl<Context>

type Redirect<From> = OpenApiRedirectOutput

The redirect converter selected for From.

impl<Context> ResultOutAlg for OpenApiHandlerImpl<Context>

type Result<Inner, Error> = OpenApiResultOutput<Inner, Error>

The converter answering with Inner on success and with what Error means otherwise.

impl<Context> RouteAlg for OpenApiHandlerImpl<Context>

type Route = OpenApiRoute

The interpreter’s composed route representation.

type Selector = OpenApiSelector

The selector applied to a route or endpoint.

type Endpoint = OpenApiEndpoint

The homogeneous endpoint representation lifted into routes.

fn initial(&self) -> Self::Route

Returns the initial route.

fn coproduct(&self, left: Self::Route, right: Self::Route) -> Self::Route

Forms the coproduct of two routes.

fn precompose( &self, selector: Self::Selector, route: Self::Route, ) -> Self::Route

Precomposes a route with a selector.

fn lift(&self, endpoint: Self::Endpoint) -> Self::Route

Lifts an endpoint into a route.

impl<Context> SelectorAlg for OpenApiHandlerImpl<Context>

type Selector = OpenApiSelector

The interpreter’s selector representation.

fn identity(&self) -> Self::Selector

Returns the selector identity.

fn compose( &self, first: Self::Selector, second: Self::Selector, ) -> Self::Selector

Composes two selectors from left to right.

impl<Context> StatusOutAlg for OpenApiHandlerImpl<Context>

type Status<Inner, const CODE: u16> = OpenApiStatusOutput<Inner, CODE>

The converter answering with CODE and the body Inner states.

impl<Context> StreamOutAlg for OpenApiHandlerImpl<Context>

type Stream<From> = OpenApiStreamOutput

The streamed converter selected for From.

impl<Context> TextOutAlg for OpenApiHandlerImpl<Context>

type Text<From> = OpenApiTextOutput

The plain-text converter selected for From.