Struct utoipa::openapi::schema::Object

source ·
#[non_exhaustive]
pub struct Object {
Show 25 fields pub schema_type: SchemaType, pub title: Option<String>, pub format: Option<SchemaFormat>, pub description: Option<String>, pub default: Option<Value>, pub enum_values: Option<Vec<Value>>, pub required: Vec<String>, pub properties: BTreeMap<String, RefOr<Schema>>, pub additional_properties: Option<Box<AdditionalProperties<Schema>>>, pub deprecated: Option<Deprecated>, pub example: Option<Value>, pub write_only: Option<bool>, pub read_only: Option<bool>, pub xml: Option<Xml>, pub nullable: bool, pub multiple_of: Option<f64>, pub maximum: Option<f64>, pub minimum: Option<f64>, pub exclusive_maximum: Option<f64>, pub exclusive_minimum: Option<f64>, pub max_length: Option<usize>, pub min_length: Option<usize>, pub pattern: Option<String>, pub max_properties: Option<usize>, pub min_properties: Option<usize>,
}
Expand description

Implements subset of OpenAPI Schema Object which allows adding other Schemas as properties to this Schema.

This is a generic OpenAPI schema object which can used to present object, field or an enum.

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 of Object e.g. SchemaType::Object for object and SchemaType::String for string types.

§title: Option<String>

Changes the Object title.

§format: Option<SchemaFormat>

Additional format for detailing the schema type.

§description: Option<String>

Description of the Object. Markdown syntax is supported.

§default: Option<Value>

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

§enum_values: Option<Vec<Value>>

Enum variants of fields that can be represented as unit type enums

§required: Vec<String>

Vector of required field names.

§properties: BTreeMap<String, RefOr<Schema>>

Map of fields with their Schema types.

With preserve_order feature flag indexmap::IndexMap will be used as properties map backing implementation to retain property order of ToSchema. By default BTreeMap will be used.

§additional_properties: Option<Box<AdditionalProperties<Schema>>>

Additional Schema for non specified fields (Useful for typed maps).

§deprecated: Option<Deprecated>

Changes the Object deprecated status.

§example: Option<Value>

Example shown in UI of the value for richer documentation.

§write_only: Option<bool>

Write only property will be only sent in write requests like POST, PUT.

§read_only: Option<bool>

Read only property will be only sent in read requests like GET.

§xml: Option<Xml>

Additional Xml formatting of the Object.

§nullable: bool

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

§multiple_of: Option<f64>

Must be a number strictly greater than 0. Numeric value is considered valid if value divided by the multiple_of value results an integer.

§maximum: Option<f64>

Specify inclusive upper limit for the Object’s value. Number is considered valid if it is equal or less than the maximum.

§minimum: Option<f64>

Specify inclusive lower limit for the Object’s value. Number value is considered valid if it is equal or greater than the minimum.

§exclusive_maximum: Option<f64>

Specify exclusive upper limit for the Object’s value. Number value is considered valid if it is strictly less than exclusive_maximum.

§exclusive_minimum: Option<f64>

Specify exclusive lower limit for the Object’s value. Number value is considered valid if it is strictly above the exclusive_minimum.

§max_length: Option<usize>

Specify maximum length for string values. max_length cannot be a negative integer value. Value is considered valid if content length is equal or less than the max_length.

§min_length: Option<usize>

Specify minimum length for string values. min_length cannot be a negative integer value. Setting this to 0 has the same effect as omitting this field. Value is considered valid if content length is equal or more than the min_length.

§pattern: Option<String>

Define a valid ECMA-262 dialect regular expression. The string content is considered valid if the pattern matches the value successfully.

§max_properties: Option<usize>

Specify inclusive maximum amount of properties an Object can hold.

§min_properties: Option<usize>

Specify inclusive minimum amount of properties an Object can hold. Setting this to 0 will have same effect as omitting the attribute.

Implementations§

source§

impl Object

source

pub fn new() -> Self

Initialize a new Object with default SchemaType. This effectively same as calling Object::with_type(SchemaType::Object).

source

pub fn with_type(schema_type: SchemaType) -> Self

Initialize new Object with given SchemaType.

Create std::string object type which can be used to define string field of an object.

let object = Object::with_type(SchemaType::String);

Trait Implementations§

source§

impl Clone for Object

source§

fn clone(&self) -> Object

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 Object

source§

fn default() -> Object

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

impl<'de> Deserialize<'de> for Object

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<Object> for ObjectBuilder

source§

fn from(value: Object) -> Self

Converts to this type from the input type.
source§

impl From<Object> for RefOr<Schema>

source§

fn from(object: Object) -> Self

Converts to this type from the input type.
source§

impl From<Object> for Schema

source§

fn from(s: Object) -> Self

Converts to this type from the input type.
source§

impl From<ObjectBuilder> for Object

source§

fn from(value: ObjectBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Object> for Object

source§

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

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 Object

source§

impl StructuralPartialEq for Object

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere T: for<'de> Deserialize<'de>,