Struct salvo_oapi::Array

#[non_exhaustive]
pub struct Array {
    pub schema_type: SchemaType,
    pub title: Option<String>,
    pub items: Box<RefOr<Schema>>,
    pub description: Option<String>,
    pub deprecated: Option<Deprecated>,
    pub examples: Vec<Value>,
    pub default_value: Option<Value>,
    pub max_items: Option<usize>,
    pub min_items: Option<usize>,
    pub unique_items: bool,
    pub xml: Option<Xml>,
    pub extensions: Option<PropMap<String, Value>>,
}

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.

schema_type: SchemaType

Type will always be SchemaType::Array

title: Option<String>

Changes the Array title.

items: Box<RefOr<Schema>>

Schema representing the array items type.

description: Option<String>

Description of the Array. Markdown syntax is supported.

deprecated: Option<Deprecated>

Marks the Array deprecated.

examples: Vec<Value>

Examples shown in UI of the value for richer documentation.

default_value: Option<Value>

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

max_items: Option<usize>

Max length of the array.

min_items: Option<usize>

Min length of the array.

unique_items: bool

Setting this to true will validate successfully if all elements of this Array are unique.

xml: Option<Xml>

Xml format of the array.

extensions: Option<PropMap<String, Value>>

Optional extensions x-something.

Implementations

impl Array

pub fn new() -> Self

Construct a new Array component from given Schema.

Examples

Create a String array component.

let string_array = Array::new().items(Object::with_type(BasicType::String));

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

Set Schema type for the Array.

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

Change type of the array e.g. to change type to string use value SchemaType::Type(Type::String).

Examples

Make nullable string array.

let _ = Array::new()
    .schema_type(SchemaType::from_iter([BasicType::Array, BasicType::Null]))
    .items(Object::with_type(BasicType::String));

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

Add or change the title of the Array.

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

Add or change description of the property. Markdown syntax is supported.

pub fn deprecated(self, deprecated: Deprecated) -> Self

Add or change deprecated status for Array.

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 example shown in UI of the value for richer documentation.

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 max_items(self, max_items: usize) -> Self

Set maximum allowed length for Array.

pub fn min_items(self, min_items: usize) -> Self

Set minimum allowed length for Array.

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

Set or change whether Array should enforce all items to be unique.

pub fn xml(self, xml: Xml) -> Self

Set Xml formatting for Array.

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

Add openapi extensions (x-something) for Array.

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

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

Formats the value using the given formatter.

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

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 PartialEq for Array

fn eq(&self, other: &Array) -> 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 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

Convert a type to Array.

impl StructuralPartialEq for Array