Struct PropertyInfo 

pub struct PropertyInfo {
    pub name: String,
    pub schema: SchemaType,
    pub description: Option<String>,
    pub required: bool,
    pub default: Option<String>,
    pub example: Option<String>,
}

Property information for object schemas.

Fields

name: String

Property name.

schema: SchemaType

Property type.

description: Option<String>

Description.

required: bool

Whether required.

default: Option<String>

Default value.

example: Option<String>

Example value.

Implementations

impl PropertyInfo

pub fn new(name: impl Into<String>, schema: SchemaType) -> Self

Create a new property info.

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

Set the description.

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

Mark as required.

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

Set the default value.

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

Set the example value.

Trait Implementations

impl Clone for PropertyInfo

fn clone(&self) -> PropertyInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyInfo

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

Formats the value using the given formatter.