Trait rocket_okapi::request::OpenApiFromParam

pub trait OpenApiFromParam<'r>: FromParam<'r> {
    fn path_parameter(
        gen: &mut OpenApiGenerator, 
        name: String
    ) -> Result<Parameter>;
}

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

Required methods

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

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

Loading content...

Implementations on Foreign Types

impl<'r> OpenApiFromParam<'r> for f32

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

impl<'r> OpenApiFromParam<'r> for f64

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

impl<'r> OpenApiFromParam<'r> for isize

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

impl<'r> OpenApiFromParam<'r> for i8

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

impl<'r> OpenApiFromParam<'r> for i16

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

impl<'r> OpenApiFromParam<'r> for i32

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

impl<'r> OpenApiFromParam<'r> for i64

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

impl<'r> OpenApiFromParam<'r> for i128

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

impl<'r> OpenApiFromParam<'r> for usize

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

impl<'r> OpenApiFromParam<'r> for u8

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

impl<'r> OpenApiFromParam<'r> for u16

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

impl<'r> OpenApiFromParam<'r> for u32

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

impl<'r> OpenApiFromParam<'r> for u64

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

impl<'r> OpenApiFromParam<'r> for u128

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

impl<'r> OpenApiFromParam<'r> for bool

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

impl<'r> OpenApiFromParam<'r> for String

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

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

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

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

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

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

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

Loading content...

Implementors

Loading content...