Struct utoipa::openapi::schema::Array

#[non_exhaustive]
pub struct Array {
    pub items: Box<RefOr<Schema>>,
    pub max_items: Option<usize>,
    pub min_items: Option<usize>,
    pub xml: Option<Xml>,
    /* private fields */
}

Array represents Vec or slice type of items.

See Schema::Array 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: Box<RefOr<Schema>>

Schema representing the array items type.

max_items: Option<usize>

Max length of the array.

min_items: Option<usize>

Min lenght of the array.

xml: Option<Xml>

Xml format of the array.

Implementations

impl Array

pub fn new<I: Into<RefOr<Schema>>>(component: I) -> Self

Construct a new Array component from given Schema.

Examples

Create a String array component.

let string_array = Array::new(Object::with_type(SchemaType::String));

pub fn to_builder(self) -> ArrayBuilder

Convert this Array to ArrayBuilder.

Trait Implementations

impl Clone for Array

fn clone(&self) -> Array

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Array

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Array

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

Deserialize this value from the given Serde deserializer.

impl From<Array> for ArrayBuilder

fn from(value: Array) -> Self

Converts to this type from the input type.

impl From<Array> for RefOr<Schema>

fn from(array: Array) -> Self

Converts to this type from the input type.

impl From<Array> for Schema

fn from(array: Array) -> Self

Converts to this type from the input type.

impl From<ArrayBuilder> for Array

fn from(value: ArrayBuilder) -> Self

Converts to this type from the input type.

impl Serialize for Array

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

Serialize this value into the given Serde serializer.

impl ToArray for Array

fn to_array(self) -> Array