Enum ParameterIn 

#[non_exhaustive]
pub enum ParameterIn {
    Query,
    Header,
    Path,
    Cookie,
    Querystring,
}

Where a parameter is carried. #[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.

Query

A named query string parameter.

The default only because a location has to be one of these; a parameter built through the constructors always has its location set explicitly.

Header

A request header.

Note that Accept, Content-Type and Authorization must not be declared this way: the specification says such a definition shall be ignored. Content negotiation belongs in the content map, and credentials belong in a SecurityScheme.

Path

A variable in the path template. Always required.

Cookie

A cookie.

Querystring

The entire query string, described by media type.

Introduced in OpenAPI 3.2. This is the sanctioned way to describe query strings that a sequence of named parameters cannot express — nested filters, JSON in the query, RFC 9535 JSONPath. It must be the only query-related parameter on its operation.

Implementations

impl ParameterIn

pub fn as_str(self) -> &'static str

The location as it is spelled in a description.

Trait Implementations

impl Clone for ParameterIn

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 ParameterIn

impl Debug for ParameterIn

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

Formats the value using the given formatter.

impl Default for ParameterIn

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParameterIn

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ParameterIn

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

Formats the value using the given formatter.

impl Eq for ParameterIn

impl Hash for ParameterIn

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ParameterIn

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ParameterIn

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 ParameterIn