Enum SpecVersion 

#[non_exhaustive]
pub enum SpecVersion {
    V3_1,
    V3_2,
}

The version of the OpenAPI Specification a document targets. #[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.

The same reasoning marks Method, ParameterIn, Style, ExampleValue and SecurityScheme. Matching one takes a wildcard arm, in either build:

fn label(version: SpecVersion) -> &'static str {
    match version {
        SpecVersion::V3_1 => "3.1",
        _ => "newer",
    }
}

Without one it does not compile, which is the guarantee: this is the error a downstream crate would otherwise have met the day something else in its build turned openapi32 on.

fn label(version: SpecVersion) -> &'static str {
    match version {
        SpecVersion::V3_1 => "3.1",
    }
}

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.

V3_1

OpenAPI 3.1, the baseline.

V3_2

OpenAPI 3.2, a strict superset of 3.1.

Implementations

impl SpecVersion

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

The version string emitted in the openapi field.

Kynos implements the 3.1.2 and 3.2.0 texts. Patch releases of the specification are clarifying rather than breaking, so a consumer that understands 3.1 understands anything emitted here.

pub fn supports_3_2(self) -> bool

Whether this version is at least 3.2.

Trait Implementations

impl Clone for SpecVersion

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 SpecVersion

impl Debug for SpecVersion

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

Formats the value using the given formatter.

impl Default for SpecVersion

fn default() -> Self

Returns the “default value” for a type.

impl Display for SpecVersion

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

Formats the value using the given formatter.

impl Eq for SpecVersion

impl Ord for SpecVersion

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SpecVersion

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SpecVersion

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SpecVersion