Struct Discriminator

#[non_exhaustive]
pub struct Discriminator {
    pub property_name: String,
    pub mapping: BTreeMap<String, String>,
}

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

Implementations

impl Discriminator

pub fn new<I>(property_name: I) -> Discriminator

where I: Into<String>,

Construct a new Discriminator object with property name.

Examples

Create a new Discriminator object for pet_type property.

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

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

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

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<Discriminator, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Discriminator

impl StructuralPartialEq for Discriminator