Skip to main content

OpenApiFileOutput

alux_http_openapi

Struct OpenApiFileOutput

pub struct OpenApiFileOutput;

Expand description

Describes streamed-file answers in a document.

Trait Implementations§

impl<File, Error> OpenApiOutputAlg<(Result<File, Error>, String)> for OpenApiFileOutput
where Error: HttpErrorAlg,

Describes a download: the bytes it answers with, and what reading the file can fail as.

A file handler answers with the file it read and the name to offer it under, so the failure is stated by the file rather than by a .result() around the endpoint. Both halves are described here: the successful body is bytes, and the failure states its own statuses.

fn answers(_schema: &JsonSchemaShape) -> Vec<OpenApiAnswer>

Describes every answer this kind states, naming the shapes it mentions along the way.

impl<From> OutputAlg<From> for OpenApiFileOutput

type Output = From

The transport value produced from the semantic handler result.

fn output(from: From) -> From

Converts a handler result into the declared API output.

Auto Trait Implementations§

impl Freeze for OpenApiFileOutput

impl RefUnwindSafe for OpenApiFileOutput

impl Send for OpenApiFileOutput

impl Sync for OpenApiFileOutput

impl Unpin for OpenApiFileOutput

impl UnsafeUnpin for OpenApiFileOutput

impl UnwindSafe for OpenApiFileOutput

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<This> HttpProgramExt<This> for This

fn compile_http<Program>( &self, program: Program, ) -> <Program as HttpProgramAlg<This>>::Route
where Program: HttpProgramAlg<This>,

Compiles a named HTTP program with this interpreter.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<This> ShapeProgramExt<This> for This

fn compile_shape<Program>( &self, program: Program, ) -> <Program as ShapeProgramAlg<This>>::Ty
where Program: ShapeProgramAlg<This>,

Folds a declaration with this interpretation.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.