Enum SchemaType

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

All possible types within a schema.

Variants

Null

Unknown

Array(Box<ArrayType>)

Boolean(Box<BooleanType>)

Enum(Box<EnumType>)

Float(Box<FloatType>)

Integer(Box<IntegerType>)

Literal(Box<LiteralType>)

Object(Box<ObjectType>)

Reference(String)

Struct(Box<StructType>)

String(Box<StringType>)

Tuple(Box<TupleType>)

Union(Box<UnionType>)

Implementations

impl 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 SchemaType

fn clone(&self) -> SchemaType

Returns a duplicate of the value.

const 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.

impl Display for SchemaType

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

Formats the value using the given formatter.

impl From<Schema> for SchemaType

fn from(val: Schema) -> Self

Converts to this type from the input type.

impl From<SchemaType> for Schema

fn from(val: SchemaType) -> Self

Converts to this type from the input type.

impl PartialEq for SchemaType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Schematic for SchemaType

fn schema_name() -> Option<String>

Define a name for this schema type. Names are required for non-primitive values as a means to link references, and avoid cycles.

fn build_schema(schema: SchemaBuilder) -> Schema

Create and return a schema that models the structure of the implementing type. The schema can be used to generate code, documentation, or other artifacts.

impl StructuralPartialEq for SchemaType