Struct utoipa::openapi::schema::Array

source ·
#[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 example: Option<Value>, pub default: Option<Value>, pub max_items: Option<usize>, pub min_items: Option<usize>, pub unique_items: bool, pub xml: Option<Xml>, pub nullable: bool, }
Expand description

Array represents Vec or slice type of items.

See Schema::Array for more details.

Fields (Non-exhaustive)§

This struct is marked as 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.

§example: Option<Value>

Example shown in UI of the value for richer documentation.

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

§nullable: bool

Set true to allow "null" to be used as value for given type.

Implementations§

source§

impl Array

source

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

Trait Implementations§

source§

impl Clone for Array

source§

fn clone(&self) -> Array

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 Array

source§

fn default() -> Self

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

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

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

source§

fn from(value: Array) -> Self

Converts to this type from the input type.
source§

impl From<Array> for RefOr<Schema>

source§

fn from(array: Array) -> Self

Converts to this type from the input type.
source§

impl From<Array> for Schema

source§

fn from(array: Array) -> Self

Converts to this type from the input type.
source§

impl From<ArrayBuilder> for Array

source§

fn from(value: ArrayBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq for Array

source§

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

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

source§

impl StructuralPartialEq for Array

Auto Trait Implementations§

§

impl Freeze for Array

§

impl RefUnwindSafe for Array

§

impl Send for Array

§

impl Sync for Array

§

impl Unpin for Array

§

impl UnwindSafe for Array

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