Struct ParamMeta 

pub struct ParamMeta {

    pub title: Option<String>,
    pub description: Option<String>,
    pub deprecated: bool,
    pub include_in_schema: bool,
    pub example: Option<Value>,
    pub examples: HashMap<String, Example>,
    pub ge: Option<f64>,
    pub le: Option<f64>,
    pub gt: Option<f64>,
    pub lt: Option<f64>,
    pub min_length: Option<usize>,
    pub max_length: Option<usize>,
    pub pattern: Option<String>,
}

Parameter metadata for OpenAPI documentation.

This struct captures metadata attributes that can be specified on struct fields using #[param(...)] attributes.

Example

#[derive(FromRequest)]
struct MyQuery {
    #[param(description = "Search term", deprecated)]
    q: Option<String>,

    #[param(title = "Page Number", ge = 1)]
    page: i32,
}

Fields

title: Option<String>

Display title for the parameter.

description: Option<String>

Description of the parameter.

deprecated: bool

Whether the parameter is deprecated.

include_in_schema: bool

Whether to include in OpenAPI schema.

example: Option<Value>

Example value.

examples: HashMap<String, Example>

Named examples.

ge: Option<f64>

Minimum value constraint (for numbers).

le: Option<f64>

Maximum value constraint (for numbers).

gt: Option<f64>

Exclusive minimum (for numbers).

lt: Option<f64>

Exclusive maximum (for numbers).

min_length: Option<usize>

Minimum length (for strings).

max_length: Option<usize>

Maximum length (for strings).

pattern: Option<String>

Pattern constraint (regex).

Implementations

impl ParamMeta

pub fn new() -> Self

Create a new parameter metadata with default values.

pub fn title(self, title: impl Into<String>) -> Self

Set the title.

pub fn description(self, description: impl Into<String>) -> Self

Set the description.

pub fn deprecated(self) -> Self

Mark as deprecated.

pub fn exclude_from_schema(self) -> Self

Exclude from OpenAPI schema.

pub fn example(self, example: Value) -> Self

Set an example value.

pub fn ge(self, value: f64) -> Self

Set minimum value constraint (>=).

pub fn le(self, value: f64) -> Self

Set maximum value constraint (<=).

pub fn gt(self, value: f64) -> Self

Set exclusive minimum constraint (>).

pub fn lt(self, value: f64) -> Self

Set exclusive maximum constraint (<).

pub fn min_length(self, len: usize) -> Self

Set minimum length for strings.

pub fn max_length(self, len: usize) -> Self

Set maximum length for strings.

pub fn pattern(self, pattern: impl Into<String>) -> Self

Set a regex pattern constraint.

pub fn to_parameter( &self, name: impl Into<String>, location: ParameterLocation, required: bool, schema: Option<Schema>, ) -> Parameter

Convert to an OpenAPI Parameter.

Trait Implementations

impl Clone for ParamMeta

fn clone(&self) -> ParamMeta

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParamMeta

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ParamMeta

fn default() -> ParamMeta

Returns the “default value” for a type.