Struct Schema

pub struct Schema {
    pub deprecated: Option<String>,
    pub description: Option<String>,
    pub name: Option<String>,
    pub nullable: bool,
    pub ty: SchemaType,
}

Describes the metadata and shape of a type.

Fields

deprecated: Option<String>

description: Option<String>

name: Option<String>

nullable: bool

ty: SchemaType

Implementations

impl Schema

pub fn new(ty: impl Into<SchemaType>) -> Self

Create a schema with the provided type.

pub fn array(value: ArrayType) -> Self

Create an array schema.

pub fn boolean(value: BooleanType) -> Self

Create a boolean schema.

pub fn enumerable(value: EnumType) -> Self

Create an enum schema.

pub fn float(value: FloatType) -> Self

Create a float schema.

pub fn integer(value: IntegerType) -> Self

Create an integer schema.

pub fn literal(value: LiteralType) -> Self

Create a literal schema.

pub fn literal_value(value: LiteralValue) -> Self

Create a literal schema with the provided value.

pub fn object(value: ObjectType) -> Self

Create an object schema.

pub fn string(value: StringType) -> Self

Create a string schema.

pub fn structure(value: StructType) -> Self

Create a struct schema.

pub fn tuple(value: TupleType) -> Self

Create a tuple schema.

pub fn union(value: UnionType) -> Self

Create a union schema.

pub fn null() -> Self

Create a null schema.

pub fn unknown() -> Self

Create an unknown schema.

pub fn nullify(&mut self)

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

pub fn partialize(&mut self)

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.

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 Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

const 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() -> Schema

Returns the “default value” for a type.

impl Deref for Schema

type Target = SchemaType

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Schema

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

Mutably dereferences the value.

impl Display for Schema

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

Formats the value using the given formatter.

impl From<Schema> for SchemaField

fn from(schema: Schema) -> Self

Converts to this type from the input type.

impl From<Schema> for SchemaType

fn from(val: Schema) -> Self

Converts to this type from the input type.

impl From<SchemaBuilder> for Schema

fn from(builder: SchemaBuilder) -> Self

Converts to this type from the input type.

impl From<SchemaField> for Schema

fn from(val: SchemaField) -> 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 Schema

fn eq(&self, other: &Schema) -> 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 Schema

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 Schema