Trait rocket_okapi::request::OpenApiFromFormField

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

This trait is used to document a query guard segment that implements FromFormField. For example ?<param> in the route’s query part.

Required Methods

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

Return a Parameter containing the information required to document the FromFormField route’s query part.

Implementors

impl<'r, T> OpenApiFromFormField<'r> for T where
    T: FromFormField<'r> + JsonSchema,