Struct Schema 

pub struct Schema { /* private fields */ }

A JSON Schema object, built a field at a time.

Only the subset every provider agrees on is modelled — an object of named, typed, described fields, some required. Anything more exotic can still be handed over with Schema::raw.

Implementations

impl Schema

pub fn object() -> Schema

pub fn raw(schema: Json) -> Schema

Use a schema written out by hand, for shapes this builder does not cover.

pub fn describe(self, description: impl Into<String>) -> Schema

Describe the object itself, which some models read as extra instruction.

pub fn string(self, name: &str, description: &str) -> Schema

pub fn integer(self, name: &str, description: &str) -> Schema

pub fn number(self, name: &str, description: &str) -> Schema

pub fn boolean(self, name: &str, description: &str) -> Schema

pub fn one_of(self, name: &str, description: &str, values: &[&str]) -> Schema

A string field limited to a fixed set of values.

pub fn array_of(self, name: &str, description: &str, item_type: &str) -> Schema

An array whose items are all of one primitive type.

pub fn nested(self, name: &str, description: &str, schema: Schema) -> Schema

A nested object.

pub fn optional(self) -> Schema

Make the field just added optional.

Fields are required by default because that is what a caller means far more often, and because an optional field a model omits is a None the handler has to think about.

pub fn to_json(&self) -> Json

The schema as the wire wants it.

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Schema

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Schema