Struct utoipa::openapi::schema::OneOfBuilder

pub struct OneOfBuilder { /* private fields */ }

Builder for OneOf with chainable configuration methods to create a new OneOf.

Implementations

impl OneOfBuilder

pub fn new() -> OneOfBuilder

Constructs a new OneOfBuilder.

pub fn build(self) -> OneOf

Constructs a new OneOf taking all fields values from this object.

impl OneOfBuilder

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

Adds a given Schema to OneOf Composite Object.

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

Add or change the title of the OneOf.

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

Add or change optional description for OneOf component.

pub fn default(self, default: Option<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(self, example: Option<Value>) -> Self

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

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

Add or change discriminator field of the composite OneOf type.

pub fn nullable(self, nullable: bool) -> Self

Add or change nullable flag for Object.

pub fn to_array_builder(self) -> ArrayBuilder

Construct a new ArrayBuilder with this component set to ArrayBuilder::items.

Trait Implementations

impl Default for OneOfBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<OneOf> for OneOfBuilder

fn from(value: 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 From<OneOfBuilder> for RefOr<Schema>

fn from(one_of: OneOfBuilder) -> Self

Converts to this type from the input type.

impl From<OneOfBuilder> for Schema

fn from(builder: OneOfBuilder) -> Self

Converts to this type from the input type.