Struct utoipa::openapi::schema::OneOf

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

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.

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

§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§

source§

impl OneOf

source

pub fn new() -> Self

Construct a new OneOf component.

source

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§

source§

impl Clone for OneOf

source§

fn clone(&self) -> OneOf

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for OneOf

source§

fn default() -> OneOf

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<OneOf> for OneOfBuilder

source§

fn from(value: OneOf) -> Self

Converts to this type from the input type.
source§

impl From<OneOf> for Schema

source§

fn from(one_of: OneOf) -> Self

Converts to this type from the input type.
source§

impl From<OneOfBuilder> for OneOf

source§

fn from(value: OneOfBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq for OneOf

source§

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

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

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.
source§

impl Serialize for OneOf

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for OneOf

Auto Trait Implementations§

§

impl Freeze for OneOf

§

impl RefUnwindSafe for OneOf

§

impl Send for OneOf

§

impl Sync for OneOf

§

impl Unpin for OneOf

§

impl UnwindSafe for OneOf

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,