Struct utoipa::openapi::schema::OneOf

pub struct OneOf {
    pub items: Vec<RefOr<Schema>>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub example: Option<Value>,
    pub discriminator: Option<Discriminator>,
    pub nullable: bool,
}

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.

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.

discriminator: Option<Discriminator>

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

nullable: bool

Set true to allow "null" to be used as value for given type.

Implementations

impl OneOf

pub fn new() -> Self

Construct a new OneOf component.

pub fn with_capacity(capacity: usize) -> Self

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 copy 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<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OneOf> for OneOfBuilder

fn from(value: OneOf) -> Self

Converts to this type from the input type.

impl From<OneOf> for Schema

fn from(one_of: OneOf) -> Self

Converts to this type from the input type.

impl From<OneOfBuilder> for OneOf

fn from(value: OneOfBuilder) -> Self

Converts to this type from the input type.

impl PartialEq<OneOf> for OneOf

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OneOf