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/single_object does not have a README file

#
SingleObjectError

pub(all) suberror SingleObjectError {
  InvalidMagic
  TruncatedHeader(actual~ : Int, required~ : Int)
  UnknownFingerprint(UInt64)
  FingerprintMismatch(expected~ : UInt64, actual~ : UInt64)
  Datum(@yugonlian/moon-avro/codec.CodecError
CodecError)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Failures produced by Avro Single-Object Encoding envelopes.

#
decode

source

fn decode(schema : @yugonlian/moon-avro/schema.Schema
Schema, input : Bytes, limits? : @yugonlian/moon-avro/codec.CodecLimits
CodecLimits) -> @yugonlian/moon-avro/codec.Datum
Datum raise SingleObjectError

Decode a Single-Object Encoding value with an expected schema. A mismatch is reported before the datum payload is interpreted.

#
decode_resolved

source

fn decode_resolved(input : Bytes, resolve : (UInt64) -> @yugonlian/moon-avro/schema.Schema
Schema?, limits? : @yugonlian/moon-avro/codec.CodecLimits
CodecLimits) -> (@yugonlian/moon-avro/schema.Schema
Schema, @yugonlian/moon-avro/codec.Datum
Datum) raise SingleObjectError

Resolve the writer schema by fingerprint and decode one Single-Object Encoding value. The resolver can use a registry, generated table or local map without coupling this package to a particular storage mechanism.

#
encode

source

fn encode(schema : @yugonlian/moon-avro/schema.Schema
Schema, datum : @yugonlian/moon-avro/codec.Datum
Datum) -> Bytes raise SingleObjectError

Encode one datum using Avro Single-Object Encoding. The result contains the marker, the schema's CRC-64-AVRO fingerprint in little-endian order, and one ordinary Avro binary datum payload.

#
fingerprint

source

fn fingerprint(input : Bytes) -> UInt64 raise SingleObjectError

Validate the ten-byte envelope prefix and return its schema fingerprint.

#
magic

source

fn magic() -> Bytes

Return the two-byte Avro Single-Object Encoding marker (C3 01).

#
matches_schema

source

fn matches_schema(input : Bytes, schema : @yugonlian/moon-avro/schema.Schema
Schema) -> Bool

Return whether an encoded value carries the supplied schema fingerprint. Malformed and truncated envelopes return false rather than raising.

Source Files

single_object.mbt

Site source Report issue Packages Build queue Skills Statistics

#SingleObjectError

#decode

#decode_resolved

#encode

#fingerprint

#magic

#matches_schema

Source Files

#
SingleObjectError

#
decode

#
decode_resolved

#
encode

#
fingerprint

#
magic

#
matches_schema