Struct OneOf 

pub struct OneOf {
    pub items: Vec<RefOr<Schema>>,
    pub schema_type: SchemaType,
    pub title: Option<String>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub example: Option<Value>,
    pub examples: Vec<Value>,
    pub discriminator: Option<Discriminator>,
    pub extensions: Option<Extensions>,
}

OneOf Composite Object component holds multiple components together where API endpoint could return any of them.

See Schema::OneOf for more details.

Fields

items: Vec<RefOr<Schema>>

Components of OneOf component.

schema_type: SchemaType

Type of OneOf e.g. SchemaType::new(Type::Object) for object.

By default this is SchemaType::AnyValue as the type is defined by items themselves.

title: Option<String>

Changes the OneOf title.

description: Option<String>

Description of the OneOf. Markdown syntax is supported.

default: Option<Value>

Default value which is provided when user has not provided the input in Swagger UI.

example: Option<Value>

Example shown in UI of the value for richer documentation.

Deprecated since 3.0.x. Prefer OneOf::examples instead

examples: Vec<Value>

Examples shown in UI of the value for richer documentation.

discriminator: Option<Discriminator>

Optional discriminator field can be used to aid deserialization, serialization and validation of a specific schema.

extensions: Option<Extensions>

Optional extensions x-something.

Implementations

impl OneOf

pub fn builder() -> OneOfBuilder

Construct a new OneOfBuilder.

This is effectively same as calling OneOfBuilder::new

impl OneOf

pub fn new() -> OneOf

Construct a new OneOf component.

pub fn with_capacity(capacity: usize) -> OneOf

Construct a new OneOf component with given capacity.

OneOf component is then able to contain number of components without reallocating.

Examples

Create OneOf component with initial capacity of 5.

let one_of = OneOf::with_capacity(5);

Trait Implementations

impl Clone for OneOf

fn clone(&self) -> OneOf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for OneOf

fn default() -> OneOf

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OneOf

fn deserialize<__D>( __deserializer: __D, ) -> Result<OneOf, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OneOf> for OneOfBuilder

fn from(value: OneOf) -> OneOfBuilder

Converts to this type from the input type.

impl From<OneOf> for Schema

fn from(one_of: OneOf) -> Schema

Converts to this type from the input type.

impl From<OneOfBuilder> for OneOf

fn from(value: OneOfBuilder) -> OneOf

Converts to this type from the input type.

impl PartialEq for OneOf

fn eq(&self, other: &OneOf) -> 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 OneOf

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 StructuralPartialEq for OneOf