Trait rocket_okapi_fork::request::OpenApiFromFormField

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

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

Required methods

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

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

Implementations on Foreign Types

impl<'r> OpenApiFromFormField<'r> for f32

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

impl<'r> OpenApiFromFormField<'r> for f64

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

impl<'r> OpenApiFromFormField<'r> for isize

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

impl<'r> OpenApiFromFormField<'r> for i8

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

impl<'r> OpenApiFromFormField<'r> for i16

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

impl<'r> OpenApiFromFormField<'r> for i32

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

impl<'r> OpenApiFromFormField<'r> for i64

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

impl<'r> OpenApiFromFormField<'r> for i128

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

impl<'r> OpenApiFromFormField<'r> for usize

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

impl<'r> OpenApiFromFormField<'r> for u8

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

impl<'r> OpenApiFromFormField<'r> for u16

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

impl<'r> OpenApiFromFormField<'r> for u32

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

impl<'r> OpenApiFromFormField<'r> for u64

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

impl<'r> OpenApiFromFormField<'r> for u128

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

impl<'r> OpenApiFromFormField<'r> for bool

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

impl<'r> OpenApiFromFormField<'r> for String

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

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

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

impl<'r, T: OpenApiFromFormField<'r>> OpenApiFromFormField<'r> for FormResult<'r, T>

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

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

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

Implementors