Trait rocket_okapi::request::OpenApiFromQuery

pub trait OpenApiFromQuery<'r>: FromQuery<'r> {
    fn query_multi_parameter(
        gen: &mut OpenApiGenerator, 
        name: String, 
        required: bool
    ) -> Result<Vec<Parameter>>;
}

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

Required methods

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

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

Loading content...

Implementations on Foreign Types

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

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

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

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

impl<'r, T> OpenApiFromQuery<'r> for Form<T> where
    T: FromForm<'r> + JsonSchema, 

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

impl<'r, T> OpenApiFromQuery<'r> for LenientForm<T> where
    T: FromForm<'r> + JsonSchema, 

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

Loading content...

Implementors

Loading content...