Struct Schema 

pub struct Schema<T: SchemaType> { /* private fields */ }

Implementations

impl<T: SchemaType> Schema<T>

pub fn component(name: &'static str, schema: Self) -> Self

impl Schema<string>

pub fn string() -> Self

impl Schema<number>

pub fn number() -> Self

impl Schema<integer>

pub fn integer() -> Self

impl Schema<bool>

pub fn bool() -> Self

impl Schema<array>

pub fn array(items: impl Into<SchemaRef>) -> Self

impl Schema<object>

pub fn object() -> Self

impl Schema<any>

pub fn any_of(schemas: impl SchemaList) -> Self

pub fn all_of(schemas: impl SchemaList) -> Self

pub fn one_of(schemas: impl SchemaList) -> Self

impl<T: SchemaType> Schema<T>

pub fn description(self, description: &'static str) -> Self

pub fn default(self, default: impl Serialize) -> Self

pub fn example(self, example: impl Serialize) -> Self

pub fn enumerates<const N: usize, V: Serialize>( self, enumerates: [V; N], ) -> Self

pub fn deprecated(self) -> Self

pub fn nullable(self) -> Self

pub fn read_only(self) -> Self

pub fn write_only(self) -> Self

impl Schema<string>

pub fn format(self, format: &'static str) -> Self

pub fn pattern(self, pattern: &'static str) -> Self

impl Schema<object>

pub fn property(self, name: &'static str, schema: impl Into<SchemaRef>) -> Self

pub fn optional(self, name: &'static str, schema: impl Into<SchemaRef>) -> Self

impl Schema<array>

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

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

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

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

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

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

pub fn unique_items(self) -> Self

impl Schema<number>

pub fn format(self, format: &'static str) -> Self

pub fn multiple_of(self, n: impl Into<f64>) -> Self

pub fn maximum(self, maximum: impl Into<f64>) -> Self

pub fn exclusive_maximum(self, maximum: impl Into<f64>) -> Self

pub fn minimum(self, minimum: impl Into<f64>) -> Self

pub fn exclusive_minimum(self, minimum: impl Into<f64>) -> Self

impl Schema<integer>

pub fn format(self, format: &'static str) -> Self

pub fn multiple_of(self, n: i32) -> Self

pub fn maximum(self, maximum: i32) -> Self

pub fn exclusive_maximum(self, maximum: i32) -> Self

pub fn minimum(self, minimum: i32) -> Self

pub fn exclusive_minimum(self, minimum: i32) -> Self

Trait Implementations

impl<T: SchemaType> From<RawSchema> for Schema<T>

fn from(raw: RawSchema) -> Self

Converts to this type from the input type.

impl<T: SchemaType> From<Schema<T>> for RawSchema

fn from(schema: Schema<T>) -> Self

Converts to this type from the input type.

impl<T: SchemaType> From<Schema<T>> for ResponseHeader

fn from(schema: Schema<T>) -> Self

Converts to this type from the input type.

impl<T: SchemaType> From<Schema<T>> for SchemaRef

fn from(schema: Schema<T>) -> Self

Converts to this type from the input type.