Struct utoipa::openapi::schema::Property

source · [−]

pub struct Property {
    pub component_type: ComponentType,
    pub format: Option<ComponentFormat>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub enum_values: Option<Vec<String>>,
    pub example: Option<Value>,
    pub deprecated: Option<Deprecated>,
    pub write_only: Option<bool>,
    pub read_only: Option<bool>,
    pub xml: Option<Xml>,
}

Expand description

Implements special subset of OpenAPI Schema Object which can be used to define field property or enum values or type for array items.

Fields

component_type: ComponentType

Type of the property e.g ComponentType::String.

format: Option<ComponentFormat>

Additional format for detailing the component type.

description: Option<String>

Description of the property. Markdown syntax is supported.

default: Option<Value>

Default value for the property which is provided when user has not provided the input.

enum_values: Option<Vec<String>>

Enum type property possible variants.

example: Option<Value>

Example shown in UI of the value for richier documentation.

deprecated: Option<Deprecated>

Changes the Property deprecated status.

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 Property.

Implementations

impl Property

pub fn new(component_type: ComponentType) -> Self

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

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

impl Default for Property

fn default() -> Property

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

impl<'de> Deserialize<'de> for Property

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

Deserialize this value from the given Serde deserializer. Read more

impl From<Property> for Component

fn from(property: Property) -> Self

Converts to this type from the input type.

impl From<Property> for PropertyBuilder

fn from(value: Property) -> Self

Converts to this type from the input type.

impl From<PropertyBuilder> for Property

fn from(value: PropertyBuilder) -> Self

Converts to this type from the input type.

impl Serialize for Property

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

Serialize this value into the given Serde serializer. Read more

impl ToArray for Property

fn to_array(self) -> Array

Auto Trait Implementations

impl RefUnwindSafe for Property

impl Send for Property

impl Sync for Property

impl Unpin for Property

impl UnwindSafe for Property

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,