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

Create a schema with the provided type.

pub fn array(value: ArrayType) -> Schema

Create an array schema.

pub fn boolean(value: BooleanType) -> Schema

Create a boolean schema.

pub fn enumerable(value: EnumType) -> Schema

Create an enum schema.

pub fn float(value: FloatType) -> Schema

Create a float schema.

pub fn integer(value: IntegerType) -> Schema

Create an integer schema.

pub fn literal(value: LiteralType) -> Schema

Create a literal schema.

pub fn literal_value(value: LiteralValue) -> Schema

Create a literal schema with the provided value.

pub fn object(value: ObjectType) -> Schema

Create an object schema.

pub fn reference(name: impl AsRef<str>) -> Schema

Create a schema that references another schema by name.

pub fn string(value: StringType) -> Schema

Create a string schema.

pub fn structure(value: StructType) -> Schema

Create a struct schema.

pub fn tuple(value: TupleType) -> Schema

Create a tuple schema.

pub fn union(value: UnionType) -> Schema

Create a union schema.

pub fn null() -> Schema

Create a null schema.

pub fn unknown() -> Schema

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, unions, and references can be marked partial, but arrays, objects, and tuples will also be recursively set to update the inner types.

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 get_default(&self) -> Option<&LiteralValue>

Return a default value from the inner schema type.

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

Set the default of the inner schema type. Returns false when the type holds no default.

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

Add a field to the inner type if it’s a struct. Returns false when it isn’t one.

pub fn is_null(&self) -> bool

Return true if the inner type is an explicit null.

pub fn is_nullable(&self) -> bool

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

pub fn is_reference(&self) -> bool

Return true if the inner type is a reference.

pub fn is_struct(&self) -> bool

Return true if the inner type is a struct.

pub fn get_nonnull_schema(&self) -> Option<&Schema>

Return a non-null schema if available. If a null type, returns None. If a union type, returns the first variant that resolves to a non-null type, or None. Otherwise, returns the current type.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

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<(), Error>

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>( __deserializer: __D, ) -> Result<Schema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Schema

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

Formats the value using the given formatter.

impl From<Schema> for SchemaType

fn from(val: Schema) -> SchemaType

Converts to this type from the input type.

impl From<Schema> for SchemaField

fn from(schema: Schema) -> SchemaField

Converts to this type from the input type.

impl From<SchemaBuilder> for Schema

fn from(builder: SchemaBuilder) -> Schema

Converts to this type from the input type.

impl From<SchemaField> for Schema

fn from(val: SchemaField) -> Schema

Converts to this type from the input type.

impl From<SchemaType> for Schema

fn from(val: SchemaType) -> Schema

Converts to this type from the input type.

impl PartialEq for Schema

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

Equality operator ==.

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

Inequality operator !=.

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 Serialize for Schema

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Schema