bobzhang/typify/schema - mooncakes.io

README
E
TypifyError
T
Case
- ::parseCrateVers::parse
- ::fn_nameDefaultImpl::fn_name
T
DefaultKind
T
EnumTagType
- ::appendName::append
- ::into_optionName::into_option
T
RefKey
T
StructProperty
T
StructPropertyRename
T
StructPropertyState
- ::describeTypeEntry::describe
- ::from_detailsTypeEntry::from_details
- ::has_implTypeEntry::has_impl
- ::nameTypeEntry::name
- ::new_floatTypeEntry::new_float
- ::new_integerTypeEntry::new_integer
- ::new_nativeTypeEntry::new_native
- ::new_native_paramsTypeEntry::new_native_params
- ::validate_valueTypeEntry::validate_value
T
TypeEntryDetails
T
TypeEntryEnum
T
TypeEntryEnumImpl
- ::name_matchTypeEntryNative::name_match
T
TypeEntryNewtype
T
TypeEntryNewtypeConstraints
T
TypeEntryStruct
T
TypeId
- ::add_ref_typesTypeSpace::add_ref_types
- ::add_root_schemaTypeSpace::add_root_schema
- ::add_typeTypeSpace::add_type
- ::add_type_with_nameTypeSpace::add_type_with_name
- ::entriesTypeSpace::entries
- ::entryTypeSpace::entry
- ::newTypeSpace::new
- ::type_countTypeSpace::type_count
- ::parseTypeSpaceImpl::parse
- ::newTypeSpacePatch::new
- ::with_attrTypeSpacePatch::with_attr
- ::with_deriveTypeSpacePatch::with_derive
- ::with_renameTypeSpacePatch::with_rename
T
TypeSpaceReplace
- ::defaultTypeSpaceSettings::default
- ::with_attrTypeSpaceSettings::with_attr
- ::with_conversionTypeSpaceSettings::with_conversion
- ::with_crateTypeSpaceSettings::with_crate
- ::with_deriveTypeSpaceSettings::with_derive
- ::with_map_typeTypeSpaceSettings::with_map_type
- ::with_patchTypeSpaceSettings::with_patch
- ::with_replacementTypeSpaceSettings::with_replacement
- ::with_struct_builderTypeSpaceSettings::with_struct_builder
- ::with_type_modTypeSpaceSettings::with_type_mod
- ::with_unknown_cratesTypeSpaceSettings::with_unknown_crates
T
UnknownPolicy
- ::newVariant::new
T
VariantDetails
V
accept_as_ident
V
recase
V
sanitize
V
std_num_nonzero_prefix

bobzhang/typify/schema does not have a README file

SchemaError

pub(all) suberror SchemaError {
  SchemaError(message~ : String, path~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A schema decoding error with serde's message and a JSON pointer to the offending value.

impl Show for SchemaError

ArrayValidation

source

pub(all) struct ArrayValidation {
  items : SingleOrVec[Schema]?
  additional_items : Schema?
  max_items : UInt?
  min_items : UInt?
  unique_items : Bool?
  contains : Schema?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ArrayValidation::default

source

fn ArrayValidation::default() -> ArrayValidation

InstanceType

source

pub(all) enum InstanceType {
  Null
  Boolean
  Object
  Array
  Number
  String
  Integer
} derive(Compare, Eq, Hash, @moonbitlang/core/debug.Debug
Debug)

The type of a JSON value (type keyword). The declaration order matters: it is schemars' derived Ord.

InstanceType::name

source

fn InstanceType::name(self : InstanceType) -> String

The JSON name of an instance type.

Metadata

source

pub(all) struct Metadata {
  id : String?
  title : String?
  description : String?
  default : @bobzhang/typify/serde_json.Value
Value?
  deprecated : Bool
  read_only : Bool
  write_only : Bool
  examples : Array[@bobzhang/typify/serde_json.Value
Value]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Annotations that do not affect validation.

Metadata::default

source

fn Metadata::default() -> Metadata

NumberValidation

source

pub(all) struct NumberValidation {
  multiple_of : Double?
  maximum : Double?
  exclusive_maximum : Double?
  minimum : Double?
  exclusive_minimum : Double?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

NumberValidation::default

source

fn NumberValidation::default() -> NumberValidation

ObjectValidation

source

pub(all) struct ObjectValidation {
  max_properties : UInt?
  min_properties : UInt?
  required : @bobzhang/typify/collections.StrSet
StrSet
  properties : @bobzhang/typify/collections.StrMap
StrMap[Schema]
  pattern_properties : @bobzhang/typify/collections.StrMap
StrMap[Schema]
  additional_properties : Schema?
  property_names : Schema?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ObjectValidation::default

source

fn ObjectValidation::default() -> ObjectValidation

RootSchema

source

pub(all) struct RootSchema {
  meta_schema : String?
  schema : SchemaObject
  definitions : @bobzhang/typify/collections.StrMap
StrMap[Schema]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The root of a schema document.

RootSchema::from_json_str

source

fn RootSchema::from_json_str(text : StringView) -> RootSchema raise

Parse and decode a root schema document from JSON text.

RootSchema::from_value

source

fn RootSchema::from_value(v : @bobzhang/typify/serde_json.Value
Value) -> RootSchema raise SchemaError

Decode a root schema document from a JSON value.

RootSchema::to_value

source

fn RootSchema::to_value(self : RootSchema) -> @bobzhang/typify/serde_json.Value
Value

Serialize to a JSON value.

Schema

source

pub(all) enum Schema {
  Bool(Bool)
  Object(SchemaObject)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A JSON Schema: either a boolean schema or a schema object.

Schema::into_object

source

fn Schema::into_object(self : Schema) -> SchemaObject

schemars Schema::into_object: true becomes {}, false becomes {"not": {}}.

Schema::is_ref

source

fn Schema::is_ref(self : Schema) -> Bool

Schema::new_ref

source

fn Schema::new_ref(reference : String) -> Schema

Schema::to_value

source

fn Schema::to_value(self : Schema) -> @bobzhang/typify/serde_json.Value
Value

Serialize to a JSON value.

SchemaObject

source

pub(all) struct SchemaObject {
  metadata : Metadata?
  instance_type : SingleOrVec[InstanceType]?
  format : String?
  enum_values : Array[@bobzhang/typify/serde_json.Value
Value]?
  const_value : @bobzhang/typify/serde_json.Value
Value?
  subschemas : SubschemaValidation?
  number : NumberValidation?
  string : StringValidation?
  array : ArrayValidation?
  object : ObjectValidation?
  reference : String?
  extensions : @bobzhang/typify/collections.StrMap
StrMap[@bobzhang/typify/serde_json.Value
Value]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A schema object. Each validation group is None when it equals its default, exactly as schemars' skip_if_default deserializes it.

SchemaObject::default

source

fn SchemaObject::default() -> SchemaObject

SchemaObject::has_type

source

fn SchemaObject::has_type(self : SchemaObject, ty : InstanceType) -> Bool

schemars has_type: true when type is absent or contains ty.

SchemaObject::is_ref

source

fn SchemaObject::is_ref(self : SchemaObject) -> Bool

SchemaObject::new_ref

source

fn SchemaObject::new_ref(reference : String) -> SchemaObject

A schema object holding only a $ref.

SchemaObject::to_value

source

fn SchemaObject::to_value(self : SchemaObject) -> @bobzhang/typify/serde_json.Value
Value

Serialize to a JSON value.

SingleOrVec

source

pub(all) enum SingleOrVec[T] {
  Single(T)
  Vec(Array[T])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A single value or an array of values (schemars SingleOrVec).

SingleOrVec::contains

source

fn[T : Eq] SingleOrVec::contains(self : SingleOrVec[T], x : T) -> Bool

StringValidation

source

pub(all) struct StringValidation {
  max_length : UInt?
  min_length : UInt?
  pattern : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

StringValidation::default

source

fn StringValidation::default() -> StringValidation

SubschemaValidation

source

pub(all) struct SubschemaValidation {
  all_of : Array[Schema]?
  any_of : Array[Schema]?
  one_of : Array[Schema]?
  not : Schema?
  if_schema : Schema?
  then_schema : Schema?
  else_schema : Schema?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

SubschemaValidation::default

source

fn SubschemaValidation::default() -> SubschemaValidation

decode_schema

source

fn decode_schema(v : @bobzhang/typify/serde_json.Value
Value, path? : String) -> Schema raise SchemaError

Decode an untagged Schema: a boolean or a schema object.

decode_schema_object

source

fn decode_schema_object(o : @bobzhang/typify/collections.StrMap
StrMap[@bobzhang/typify/serde_json.Value
Value], path? : String) -> SchemaObject raise SchemaError

Decode a schema object from the entries of a JSON object.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#SchemaError

#ArrayValidation

#ArrayValidation::default

#InstanceType

#InstanceType::name

#Metadata

#Metadata::default

#NumberValidation

#NumberValidation::default

#ObjectValidation

#ObjectValidation::default

#RootSchema

#RootSchema::from_json_str

#RootSchema::from_value

#RootSchema::to_value

#Schema

#Schema::into_object

#Schema::is_ref

#Schema::new_ref

#Schema::to_value

#SchemaObject

#SchemaObject::default

#SchemaObject::has_type

#SchemaObject::is_ref

#SchemaObject::new_ref

#SchemaObject::to_value

#SingleOrVec

#SingleOrVec::contains

#StringValidation

#StringValidation::default

#SubschemaValidation

#SubschemaValidation::default

#decode_schema

#decode_schema_object

Source Files

SchemaError

ArrayValidation

ArrayValidation::default

InstanceType

InstanceType::name

Metadata

Metadata::default

NumberValidation

NumberValidation::default

ObjectValidation

ObjectValidation::default

RootSchema

RootSchema::from_json_str

RootSchema::from_value

RootSchema::to_value

Schema

Schema::into_object

Schema::is_ref

Schema::new_ref

Schema::to_value

SchemaObject

SchemaObject::default

SchemaObject::has_type

SchemaObject::is_ref

SchemaObject::new_ref

SchemaObject::to_value

SingleOrVec

SingleOrVec::contains

StringValidation

StringValidation::default

SubschemaValidation

SubschemaValidation::default

decode_schema

decode_schema_object