Enum ParamStyle

pub enum ParamStyle {
    Default,
    Form,
    Simple,
    SpaceDelimited,
    PipeDelimited,
    Label,
    Matrix,
    DeepObject,
}

Parameter styles supported by OpenAPI 3.1 specification.

These styles define how array values and complex parameters are serialized in strings according to the OpenAPI standard.

Examples

use clawspec_core::{ParamStyle, ParamValue, CallQuery};

// Form style (default) - arrays are repeated: ?tags=rust&tags=web&tags=api
let form_query = ParamValue::new(vec!["rust", "web", "api"]);
assert_eq!(form_query.query_style(), ParamStyle::Form);

// Space delimited - arrays are joined with spaces: ?tags=rust%20web%20api
let space_query = ParamValue::with_style(
    vec!["rust", "web", "api"],
    ParamStyle::SpaceDelimited
);

// Pipe delimited - arrays are joined with pipes: ?tags=rust|web|api
let pipe_query = ParamValue::with_style(
    vec!["rust", "web", "api"],
    ParamStyle::PipeDelimited
);

Variants

Default

Default style - will use Form for query parameters and Simple for path parameters

Form

Form style: param=value1&param=value2 (query default)

Simple

Simple style: value1,value2 (path default)

SpaceDelimited

Space delimited: param=value1 value2

PipeDelimited

Pipe delimited: param=value1|value2

Label

Label style: /users/.value (path parameter with . prefix)

Matrix

Matrix style: /users/;name=value (path parameter with ; prefix)

DeepObject

Deep object style: ?obj[key]=value (query parameter for nested objects)

Trait Implementations

impl Clone for ParamStyle

fn clone(&self) -> ParamStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamStyle

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

Formats the value using the given formatter.

impl From<ParamStyle> for Option<ParameterStyle>

fn from(value: ParamStyle) -> Self

Converts to this type from the input type.

impl PartialEq for ParamStyle

fn eq(&self, other: &ParamStyle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ParamStyle

impl Eq for ParamStyle

impl StructuralPartialEq for ParamStyle