Struct Discriminator

pub struct Discriminator {
    pub property_name: String,
    pub mapping: BTreeMap<String, String>,
    pub extensions: Option<Extensions>,
}

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

Fields

property_name: String

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

mapping: BTreeMap<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.

extensions: Option<Extensions>

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 with_mapping<P: Into<String>, M: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>>( property_name: P, mapping: M, ) -> Self

Construct a new Discriminator object with property name and mappings.

Method accepts two arguments. First property_name to use as discriminator and mapping for custom property name mappings.

Examples

Construct an ew Discriminator with custom mapping.

let discriminator = Discriminator::with_mapping("pet_type", [
    ("cat","#/components/schemas/Cat")
]);

Trait Implementations

impl Clone for Discriminator

fn clone(&self) -> Discriminator

Returns a copy of the value.

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

Performs copy-assignment from source.

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 PartialEq for Discriminator

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 Eq for Discriminator

impl StructuralPartialEq for Discriminator