Enum Style 

#[non_exhaustive]
pub enum Style {
    Matrix,
    Label,
    Simple,
    Form,
    SpaceDelimited,
    PipeDelimited,
    DeepObject,
    Cookie,
}

How a parameter value is serialized.

Not every combination of style and location is legal; OpenAPI 3.2 states that the table of valid combinations is closed. crate::validate checks the pairing. #[non_exhaustive] because OpenAPI 3.2 adds to this and the addition is #[cfg]-gated. Cargo unifies features across a dependency graph, so any crate enabling openapi32 enables it for every crate in the build – and without this attribute that would turn a downstream exhaustive match into a compile error, which is not what “purely additive” is supposed to mean.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Matrix

Path-style parameters defined by RFC 6570. Path only.

Label

Label-style expansion defined by RFC 6570. Path only.

Simple

Comma-separated values. The default for path and header.

Form

Form-style expansion. The default for query and cookie.

SpaceDelimited

Space-separated array or object values. Query only.

PipeDelimited

Pipe-separated array or object values. Query only.

DeepObject

Nested objects rendered as param[prop]=value.

Query only, and defined only for objects whose properties are scalars. Anything deeper needs ParameterIn::Querystring.

Cookie

Cookie-style serialization.

Introduced in OpenAPI 3.2. Cookie only.

Implementations

impl Style

pub fn default_for(location: ParameterIn) -> Self

The style applied when none is stated, given a parameter location.

pub fn is_valid_for(self, location: ParameterIn) -> bool

Whether this style may be used at the given location.

pub fn default_explode(self) -> bool

Whether explode defaults to true for this style.

The two styles that pair a name with each value default to exploding; every other style defaults to false.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Style

impl Debug for Style

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Style

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Style

impl From<EncodingStyle> for Style

fn from(style: EncodingStyle) -> Self

Converts to this type from the input type.

impl From<HeaderStyle> for Style

fn from(_: HeaderStyle) -> Self

Converts to this type from the input type.

impl PartialEq for Style

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Style

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Style