Trait rocket_okapi::request::OpenApiFromFormValue

pub trait OpenApiFromFormValue<'r>: FromFormValue<'r> {
    fn query_parameter(
        gen: &mut OpenApiGenerator, 
        name: String, 
        required: bool
    ) -> Result<Parameter>;
}

This trait means that the implementer can be used as a FromFormValue request guard, and that this can also be documented.

Required methods

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

Return a RequestBody containing the information required to document the FromFormValue for implementer.

Loading content...

Implementations on Foreign Types

impl<'r> OpenApiFromFormValue<'r> for f32

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for f64

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for isize

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for i8

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for i16

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for i32

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for i64

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for i128

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for usize

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for u8

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for u16

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for u32

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for u64

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for u128

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for bool

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r> OpenApiFromFormValue<'r> for String

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

impl<'r, T: OpenApiFromFormValue<'r>> OpenApiFromFormValue<'r> for StdResult<T, T::Error>

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    required: bool
) -> Result<Parameter>

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

fn query_parameter(
    gen: &mut OpenApiGenerator,
    name: String,
    _required: bool
) -> Result<Parameter>

Loading content...

Implementors

Loading content...