mooncakes.io

cmd
→
codec
→
examples
→
json
→
ocf
→
schema
→
single_object
→
README
U
CodecError
U
CodecLimits
U
CompressionCodec
U
Datum
U
Decoder
U
Encoder
U
Field
U
JsonError
U
JsonLimits
U
NamedDefinition
U
OcfBlockConfig
U
OcfError
U
OcfHeader
U
OcfLimits
U
OcfReader
U
OcfWriter
U
Primitive
U
Schema
U
SchemaError
U
SchemaKind
U
SingleObjectError
V
decode
V
decode_container
V
decode_from
V
decode_header
V
decode_single_object
V
decode_single_object_resolved
V
default_block_config
V
default_limits
V
encode
V
encode_container
V
encode_container_blocks
V
encode_header
V
encode_into
V
encode_single_object
V
from_json
V
is_ocf
V
magic
V
parse
V
parse_json
V
single_object_fingerprint
V
stringify
V
to_json

README

yugonlian/moon-avro/schema does not have a README file

#
SchemaError

pub(all) suberror SchemaError {
  EmptySchema
  UnsupportedSchema(String)
  DuplicateName(String)
  UnknownName(String)
  InvalidJson(String)
  InvalidSchema(String)
  InvalidName(String)
  InvalidDefault(field~ : String, reason~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Errors produced while parsing, naming, or validating an Avro schema.

#
Field

source

pub(all) struct Field {
  name : String
  schema : Schema
  default_value : Json?
  aliases : Array[String]
  doc : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A field in an Avro record declaration.

#
Field::aliases

source

fn Field::aliases(self : Field) -> Array[String]

#
Field::default_value

source

fn Field::default_value(self : Field) -> Json?

#
Field::name

source

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

#
Field::schema

source

fn Field::schema(self : Field) -> Schema

#
NamedDefinition

source

pub(all) struct NamedDefinition {
  name : String
  kind : SchemaKind
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A named definition retained by the root schema for reference resolution.

#
Primitive

source

pub(all) enum Primitive {
  Null
  Boolean
  Int
  Long
  Float
  Double
  Bytes
  String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Primitive types defined by the Apache Avro data model.

#
Schema

source

pub struct Schema {
  kind : SchemaKind
  source : String
  definitions : Array[NamedDefinition]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Parsed Avro schema with its source retained for diagnostics and canonical form generation.

#
Schema::canonical_form

source

fn Schema::canonical_form(self : Schema) -> String

Return Avro parsing canonical form (PCF) for this schema.

#
Schema::definition_names

source

fn Schema::definition_names(self : Schema) -> Array[String]

Return the full names declared by this parsed root schema.

#
Schema::fingerprint64

source

fn Schema::fingerprint64(self : Schema) -> UInt64

Compute the Avro single-object-encoding CRC-64-AVRO fingerprint of the parsing canonical form.

#
Schema::kind

source

fn Schema::kind(self : Schema) -> SchemaKind

#
Schema::kind_name

source

fn Schema::kind_name(self : Schema) -> String

#
Schema::new

source

fn Schema::new(kind : SchemaKind, source : String) -> Schema

#
Schema::resolve_named

source

fn Schema::resolve_named(self : Schema, name : String) -> SchemaKind?

Resolve a full or declared alias name from this parsed root schema.

#
Schema::source

source

fn Schema::source(self : Schema) -> String

#
SchemaKind

source

pub(all) enum SchemaKind {
  Primitive(Primitive)
  Record(name~ : String, namespace_~ : String?, aliases~ : Array[String], fields~ : Array[Field])
  Enum(name~ : String, namespace_~ : String?, aliases~ : Array[String], symbols~ : Array[String], default_symbol~ : String?)
  Array(items~ : Schema)
  Map(values~ : Schema)
  Union(branches~ : Array[Schema])
  Fixed(name~ : String, namespace_~ : String?, aliases~ : Array[String], size~ : Int)
  Named(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The complete Avro schema algebra. Named is a resolved full-name reference; use Schema::resolve_named on the root schema to inspect its declaration.

#
parse

source

fn parse(input : String) -> Schema raise SchemaError

Parse an Avro JSON schema, resolve named references, and retain named declarations for later datum and OCF consumers.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#SchemaError

#Field

#Field::aliases

#Field::default_value

#Field::name

#Field::schema

#NamedDefinition

#Primitive

#Schema

#Schema::canonical_form

#Schema::definition_names

#Schema::fingerprint64

#Schema::kind

#Schema::kind_name

#Schema::new

#Schema::resolve_named

#Schema::source

#SchemaKind

#parse

Source Files

#
SchemaError

#
Field

#
Field::aliases

#
Field::default_value

#
Field::name

#
Field::schema

#
NamedDefinition

#
Primitive

#
Schema

#
Schema::canonical_form

#
Schema::definition_names

#
Schema::fingerprint64

#
Schema::kind

#
Schema::kind_name

#
Schema::new

#
Schema::resolve_named

#
Schema::source

#
SchemaKind

#
parse