Trait rocket_okapi::request::OpenApiFromData

source · [−]

pub trait OpenApiFromData<'r>: FromData<'r> {
    fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>;
}

Expand description

This trait is used to document the request body that implements FromData.

Required Methods

source

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

Return a RequestBody containing the information required to document the FromData object.

Implementations on Foreign Types

source

impl<'r, T: OpenApiFromData<'r> + 'r> OpenApiFromData<'r> for StdResult<T, T::Error>

source

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

source

impl<'r, T: OpenApiFromData<'r>> OpenApiFromData<'r> for Option<T>

source

Trait rocket_okapi::request::OpenApiFromData

Required Methods

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

Implementations on Foreign Types

impl<'r> OpenApiFromData<'r> for &'r str

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Cow<'r, str>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for &'r [u8]

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for TempFile<'r>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Capped<TempFile<'r>>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Capped<Cow<'r, str>>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for &'r RawStr

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for String

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Vec<u8>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Capped<&'r str>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Capped<&'r RawStr>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Capped<&'r [u8]>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Capped<String>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Capped<Vec<u8>>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r> OpenApiFromData<'r> for Data<'r>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r, T: JsonSchema + OpenApiFromForm<'r>> OpenApiFromData<'r> for Form<T>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r, T: JsonSchema + Deserialize<'r>> OpenApiFromData<'r> for Json<T>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r, T: OpenApiFromData<'r> + 'r> OpenApiFromData<'r> for StdResult<T, T::Error>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

impl<'r, T: OpenApiFromData<'r>> OpenApiFromData<'r> for Option<T>

fn request_body(gen: &mut OpenApiGenerator) -> Result<RequestBody>

Implementors