Struct Discriminator 

#[non_exhaustive]
pub struct Discriminator {
    pub property_name: String,
    pub mapping: PropMap<String, String>,
    pub default_mapping: Option<String>,
    pub extensions: PropMap<String, Value>,
}

OpenAPI Discriminator object which can be optionally used together with OneOf composite object.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

property_name: String

Defines a discriminator property name which must be found within all composite objects.

mapping: PropMap<String, String>

An object to hold mappings between payload values and schema names or references. This field can only be populated manually. There is no macro support and no validation.

default_mapping: Option<String>

The schema name or URI reference to the schema that validates the payload when the discriminating property is absent, or holds a value with no explicit or implicit mapping. Added in OpenAPI 3.2.

Required by the spec when the discriminating property is optional.

See https://spec.openapis.org/oas/v3.2.0.html#discriminator-object.

extensions: PropMap<String, Value>

Optional extensions “x-something”

Implementations

impl Discriminator

pub fn new<I: Into<String>>(property_name: I) -> Self

Construct a new Discriminator object with property name.

Examples

Create a new Discriminator object for pet_type property.

let discriminator = Discriminator::new("pet_type");

pub fn add_mapping<K: Into<String>, V: Into<String>>( self, value: K, schema: V, ) -> Self

Add a mapping between a payload value and a schema name or URI reference.

pub fn default_mapping<I: Into<String>>(self, default_mapping: I) -> Self

Set the fallback schema used when the discriminating property is missing or unmapped. Requires OpenAPI 3.2.

pub fn extensions(self, extensions: PropMap<String, Value>) -> Self

Add openapi extensions (x-something) for Discriminator.

Trait Implementations

impl Clone for Discriminator

fn clone(&self) -> Discriminator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Discriminator

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

Formats the value using the given formatter.

impl Default for Discriminator

fn default() -> Discriminator

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Discriminator

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Discriminator

impl PartialEq for Discriminator

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Discriminator

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 Discriminator