Enum schematic_types::SchemaType

pub enum SchemaType {
    Null,
    Unknown,
    Array(ArrayType),
    Boolean(BooleanType),
    Enum(EnumType),
    Float(FloatType),
    Integer(IntegerType),
    Literal(LiteralType),
    Object(ObjectType),
    Struct(StructType),
    String(StringType),
    Tuple(TupleType),
    Union(UnionType),
}

All possible types within a schema.

Variants

Null

Unknown

Array(ArrayType)

Boolean(BooleanType)

Enum(EnumType)

Float(FloatType)

Integer(IntegerType)

Literal(LiteralType)

Object(ObjectType)

Struct(StructType)

String(StringType)

Tuple(TupleType)

Union(UnionType)

Implementations

impl SchemaType

pub fn infer<T: Schematic>() -> SchemaType

Infer a schema from a type that implements Schematic.

pub fn infer_with_default<T: Schematic>(default: LiteralValue) -> SchemaType

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

pub fn infer_partial<T: Schematic>() -> SchemaType

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

pub fn array(items_type: SchemaType) -> SchemaType

Create an array schema with the provided item types.

pub fn boolean() -> SchemaType

Create a boolean type.

pub fn enumerable<I>(values: I) -> SchemaType

where I: IntoIterator<Item = LiteralValue>,

Create an enumerable type with the provided literal values.

pub fn float(kind: FloatKind) -> SchemaType

Create a float schema with the provided kind.

pub fn integer(kind: IntegerKind) -> SchemaType

Create an integer schema with the provided kind.

pub fn literal(value: LiteralValue) -> SchemaType

Create a literal schema with the provided value.

pub fn nullable(schema: SchemaType) -> SchemaType

Convert the provided schema to a nullable type. If already nullable, do nothing and return, otherwise convert to a union.

pub fn object(key_type: SchemaType, value_type: SchemaType) -> SchemaType

Create an indexed/mapable object schema with the provided key and value types.

pub fn string() -> SchemaType

Create a string schema.

pub fn structure<I>(fields: I) -> SchemaType

where I: IntoIterator<Item = SchemaField>,

Create a struct/shape schema with the provided fields.

pub fn tuple<I>(items_types: I) -> SchemaType

where I: IntoIterator<Item = SchemaType>,

Create a tuple schema with the provided item types.

pub fn union<I>(variants_types: I) -> SchemaType

where I: IntoIterator<Item = SchemaType>,

Create an “any of” union.

pub fn union_one<I>(variants_types: I) -> SchemaType

where I: IntoIterator<Item = SchemaType>,

Create a “one of” union.

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

Return a default value from the inner schema type.

pub fn get_name(&self) -> Option<&String>

Return a name 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_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 set_name<S: AsRef<str>>(&mut self, name: S)

Set the name of the inner schema type. If the inner type does not support names, this is a no-op.

pub fn set_partial(&mut self, state: bool)

Mark the inner schema type as partial. Only structs and unions can be marked partial, but arrays and objects will also be recursively set to update the inner type.

pub fn add_field(&mut self, field: SchemaField)

Add the field to the inner schema type. This is only applicable to enums, structs, and unions, otherwise this is a no-op.

Trait Implementations

impl Clone for SchemaType

fn clone(&self) -> SchemaType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaType

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

Formats the value using the given formatter.

impl Default for SchemaType

fn default() -> SchemaType

Returns the “default value” for a type.