Enum ExampleValue 

#[non_exhaustive]
pub enum ExampleValue {
    Embedded(Value),
    #[non_exhaustive]
    External {
        uri: String,
        data: Option<Value>,
    },
    Data {
        data: Value,
        serialized: Option<String>,
    },
    Serialized(String),
}

The example itself, in whichever form carries it.

The specification’s exclusions are asymmetric, so this is not a one-of over four fields. value excludes all three others; serializedValue and externalValue exclude each other; but dataValue pairs with either of them, which is how the specification’s own worked examples are written. The variants below are exactly the combinations that leaves. #[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.

Embedded(Value)

An embedded literal example, written to value.

Exclusive with every other form. Deprecated by 3.2 for non-JSON serialization targets; see the type-level documentation.

Named for what it is rather than for its field: a variant called Value would collide with serde_json::Value in rustc’s shortest-path table and lengthen that type’s name in every diagnostic mentioning it, this crate’s or anyone else’s.

#[non_exhaustive]

External

A URI identifying the serialized example, written to externalValue.

For payloads that cannot be embedded in JSON or YAML.

#[non_exhaustive] on the variant, because 3.2 adds data to it. The attribute on the enum covers a variant being added and says nothing about this one’s field list; see the type’s own documentation.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

uri: String

The URI identifying the example.

data: Option<Value>

The data the URI serializes, written to dataValue.

Data

The example as data, written to dataValue.

Introduced in OpenAPI 3.2.

Fields

data: Value

The example as a data structure, before serialization.

serialized: Option<String>

The same example on the wire, written to serializedValue.

Serialized(String)

The example exactly as it appears on the wire, written to serializedValue, with no data form given.

Introduced in OpenAPI 3.2.

Trait Implementations

impl Clone for ExampleValue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleValue

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

Formats the value using the given formatter.

impl Eq for ExampleValue

impl PartialEq for ExampleValue

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExampleValue