Struct salvo_oapi::schema::OneOf

#[non_exhaustive]
pub struct OneOf {
    pub items: Vec<RefOr<Schema>>,
    pub schema_type: SchemaType,
    pub title: Option<String>,
    pub description: Option<String>,
    pub default_value: Option<Value>,
    pub examples: Vec<Value>,
    pub discriminator: Option<Discriminator>,
    pub extensions: Option<PropMap<String, Value>>,
}

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

See Schema::OneOf for more details.

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.

items: Vec<RefOr<Schema>>

Components of OneOf component.

schema_type: SchemaType

Type of OneOf e.g. SchemaType::basic(BasicType::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_value: Option<Value>

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

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<PropMap<String, Value>>

Optional extensions x-something.

Implementations

impl OneOf

pub fn new() -> Self

Construct a new empty OneOf. This is effectively same as calling OneOf::default.

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);

pub fn item<I: Into<RefOr<Schema>>>(self, component: I) -> Self

Adds a given Schema to OneOf Composite Object

pub fn schema_type<T: Into<SchemaType>>(self, schema_type: T) -> Self

Add or change type of the object e.g. to change type to string use value SchemaType::Type(Type::String).

pub fn title(self, title: impl Into<String>) -> Self

Add or change the title of the OneOf.

pub fn description(self, description: impl Into<String>) -> Self

Add or change optional description for OneOf component.

pub fn default_value(self, default: Value) -> Self

Add or change default value for the object which is provided when user has not provided the input in Swagger UI.

pub fn example<V: Into<Value>>(self, example: V) -> Self

Add or change example shown in UI of the value for richer documentation.

pub fn examples<I: IntoIterator<Item = V>, V: Into<Value>>( self, examples: I, ) -> Self

Add or change examples shown in UI of the value for richer documentation.

pub fn discriminator(self, discriminator: Discriminator) -> Self

Add or change discriminator field of the composite OneOf type.

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

Add openapi extensions (x-something) for OneOf.

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

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

Formats the value using the given formatter.

impl Default for OneOf

fn default() -> Self

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 RefOr<Schema>

fn from(one_of: 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 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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OneOf