Struct SchemaBuilder

pub struct SchemaBuilder { /* private fields */ }

A Schema builder.

Implementations

impl SchemaBuilder

pub fn generate<T: Schematic>() -> Schema

Generate a schema from the provided type.

pub fn build_root<T: Schematic>() -> Schema

Generate a schema from the provided type.

pub fn build(&mut self) -> Schema

Build the schema from the configured values.

pub fn set_deprecated(&mut self, value: impl AsRef<str>)

Mark this schema as deprecated.

pub fn set_description(&mut self, value: impl AsRef<str>)

Add a description for this schema.

pub fn set_name(&mut self, value: impl AsRef<str>)

Add a name for this schema.

pub fn set_type(&mut self, value: SchemaType)

Set the type of schema.

pub fn set_type_and_build(&mut self, value: SchemaType) -> Schema

Set the type of schema and then build it.

pub fn array(&mut self, value: ArrayType) -> Schema

Build an array type.

pub fn boolean(&mut self, value: BooleanType) -> Schema

Build a boolean type.

pub fn boolean_default(&mut self) -> Schema

Build a boolean type with default settings.

pub fn enumerable(&mut self, value: EnumType) -> Schema

Build an enum type.

pub fn float(&mut self, value: FloatType) -> Schema

Build a float type.

pub fn float32_default(&mut self) -> Schema

Build a 32bit float type with default settings.

pub fn float64_default(&mut self) -> Schema

Build a 64bit float type with default settings.

pub fn integer(&mut self, value: IntegerType) -> Schema

Build an integer type.

pub fn literal(&mut self, value: LiteralType) -> Schema

Build a literal type.

pub fn literal_value(&mut self, value: LiteralValue) -> Schema

Build a literal type with a value.

pub fn nest(&self) -> SchemaBuilder

Build a nested Schema by cloning another builder.

pub fn nullable(&mut self, value: impl Into<Schema>) -> Schema

Build a schema that is also nullable (uses a union).

pub fn object(&mut self, value: ObjectType) -> Schema

Build an object type.

pub fn string(&mut self, value: StringType) -> Schema

Build a string type.

pub fn string_default(&mut self) -> Schema

Build a string type with default settings.

pub fn structure(&mut self, value: StructType) -> Schema

Build a struct type.

pub fn tuple(&mut self, value: TupleType) -> Schema

Build a tuple type.

pub fn union(&mut self, value: UnionType) -> Schema

Build a union type.

pub fn infer<T: Schematic>(&self) -> Schema

Infer a Schema from a type that implements Schematic.

pub fn infer_as_nested<T: Schematic>(&self) -> Schema

Infer a Schema from a type that implements Schematic, and mark the schema is partial (is marked as nested).

pub fn infer_with_default<T: Schematic>(&self, default: LiteralValue) -> Schema

Infer a Schema from a type that implements Schematic, and also provide a default literal value.

Methods from Deref<Target = SchemaType>

pub fn get_default(&self) -> Option<&LiteralValue>

Return a default value from the inner schema type.

pub fn is_null(&self) -> bool

Return true if the schema is an explicit null.

pub fn is_nullable(&self) -> bool

Return true if the schema is nullable (a union with a null).

pub fn is_reference(&self) -> bool

Return true if the schema is a reference.

pub fn is_struct(&self) -> bool

Return true if the schema is a struct.

pub fn set_default(&mut self, default: LiteralValue)

Set the default of the inner schema type.

pub fn add_field(&mut self, key: &str, value: impl Into<SchemaField>)

Add a field to the type if it’s a struct.

Trait Implementations

impl Clone for SchemaBuilder

fn clone(&self) -> SchemaBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaBuilder

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

Formats the value using the given formatter.

impl Default for SchemaBuilder

fn default() -> SchemaBuilder

Returns the “default value” for a type.

impl Deref for SchemaBuilder

type Target = SchemaType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SchemaBuilder

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<SchemaBuilder> for Schema

fn from(builder: SchemaBuilder) -> Self

Converts to this type from the input type.