yugonlian/moon-avro/codec

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

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

CodecError

pub(all) suberror CodecError {
  TypeMismatch(expected~ : String, actual~ : String)
  UnexpectedEof(offset~ : Int)
  InvalidEncoding(offset~ : Int, message~ : String)
  InvalidLength(offset~ : Int, length~ : Int64)
  LimitExceeded(offset~ : Int, limit~ : String)
  MissingField(field~ : String)
  TrailingData(offset~ : Int)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Binary datum codec failures.

CodecLimits

source

pub struct CodecLimits {
  max_depth : Int
  max_collection_items : Int
  max_bytes : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Resource limits applied while decoding or constructing Avro binary data.

Limits are deliberately part of the public API: callers reading untrusted streams should choose bounds appropriate for their protocol.

CodecLimits::max_bytes

source

fn CodecLimits::max_bytes(self : CodecLimits) -> Int

CodecLimits::max_collection_items

source

fn CodecLimits::max_collection_items(self : CodecLimits) -> Int

CodecLimits::max_depth

source

fn CodecLimits::max_depth(self : CodecLimits) -> Int

CodecLimits::new

source

fn CodecLimits::new(max_depth? : Int, max_collection_items? : Int, max_bytes? : Int) -> CodecLimits

Datum

source

pub(all) enum Datum {
  Null
  Boolean(Bool)
  Int(Int)
  Long(Int64)
  Float(Float)
  Double(Double)
  Bytes(Bytes)
  String(String)
  Array(Array[Datum])
  Map(Map[String, Datum])
  Record(Array[(String, Datum)])
  Enum(Int, String)
  Union(Int, Datum)
  Fixed(Bytes)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Runtime values accepted by the generic Avro datum codec.

Decoder

source

pub struct Decoder {
  input : Bytes
  offset : Int
  limits : CodecLimits
} derive(@moonbitlang/core/debug.Debug
Debug)

A bounded cursor over an Avro binary byte sequence.

Decoder::ensure_finished

source

fn Decoder::ensure_finished(self : Decoder) -> Unit raise CodecError

Decoder::limits

source

fn Decoder::limits(self : Decoder) -> CodecLimits

Decoder::new

source

fn Decoder::new(input : Bytes, limits? : CodecLimits) -> Decoder raise CodecError

Decoder::offset

source

fn Decoder::offset(self : Decoder) -> Int

Decoder::read_byte

source

fn Decoder::read_byte(self : Decoder) -> Byte raise CodecError

Decoder::read_bytes

source

fn Decoder::read_bytes(self : Decoder) -> Bytes raise CodecError

Decoder::read_double

source

fn Decoder::read_double(self : Decoder) -> Double raise CodecError

Decoder::read_float

source

fn Decoder::read_float(self : Decoder) -> Float raise CodecError

Decoder::read_int

source

fn Decoder::read_int(self : Decoder) -> Int raise CodecError

Decoder::read_long

source

fn Decoder::read_long(self : Decoder) -> Int64 raise CodecError

Decoder::read_raw

source

fn Decoder::read_raw(self : Decoder, length : Int) -> Bytes raise CodecError

Decoder::read_string

source

fn Decoder::read_string(self : Decoder) -> String raise CodecError

Decoder::remaining

source

fn Decoder::remaining(self : Decoder) -> Int

Encoder

source

pub struct Encoder {
  buffer : @moonbitlang/core/buffer.Buffer
Buffer
  limits : CodecLimits
} derive(@moonbitlang/core/debug.Debug
Debug)

A growable Avro-binary writer. It uses Avro's little-endian float layout and zigzag LEB128 integer representation.

Encoder::length

source

fn Encoder::length(self : Encoder) -> Int

Encoder::new

source

fn Encoder::new(limits? : CodecLimits) -> Encoder

Encoder::to_bytes

source

fn Encoder::to_bytes(self : Encoder) -> Bytes

Encoder::write_byte

source

fn Encoder::write_byte(self : Encoder, byte : Byte) -> Unit raise CodecError

Encoder::write_bytes

source

fn Encoder::write_bytes(self : Encoder, value : BytesView) -> Unit raise CodecError

Encoder::write_double

source

fn Encoder::write_double(self : Encoder, value : Double) -> Unit raise CodecError

Encoder::write_float

source

fn Encoder::write_float(self : Encoder, value : Float) -> Unit raise CodecError

Encoder::write_int

source

fn Encoder::write_int(self : Encoder, value : Int) -> Unit raise CodecError

Encoder::write_long

source

fn Encoder::write_long(self : Encoder, value : Int64) -> Unit raise CodecError

Encoder::write_raw

source

fn Encoder::write_raw(self : Encoder, bytes : BytesView) -> Unit raise CodecError

Encoder::write_string

source

fn Encoder::write_string(self : Encoder, value : StringView) -> Unit raise CodecError

decode

source

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

Decode one datum according to an Avro schema and reject trailing bytes.

decode_from

source

fn decode_from(schema : @yugonlian/moon-avro/schema.Schema
Schema, decoder : Decoder) -> Datum raise CodecError

Decode one datum from a caller-owned stream decoder, leaving later bytes available for the next datum.

encode

source

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

Encode one datum according to an Avro schema.

encode_into

source

fn encode_into(schema : @yugonlian/moon-avro/schema.Schema
Schema, datum : Datum, encoder : Encoder) -> Unit raise CodecError

Encode one datum into a caller-owned stream encoder.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#CodecError

#CodecLimits

#CodecLimits::max_bytes

#CodecLimits::max_collection_items

#CodecLimits::max_depth

#CodecLimits::new

#Datum

#Decoder

#Decoder::ensure_finished

#Decoder::limits

#Decoder::new

#Decoder::offset

#Decoder::read_byte

#Decoder::read_bytes

#Decoder::read_double

#Decoder::read_float

#Decoder::read_int

#Decoder::read_long

#Decoder::read_raw

#Decoder::read_string

#Decoder::remaining

#Encoder

#Encoder::length

#Encoder::new

#Encoder::to_bytes

#Encoder::write_byte

#Encoder::write_bytes

#Encoder::write_double

#Encoder::write_float

#Encoder::write_int

#Encoder::write_long

#Encoder::write_raw

#Encoder::write_string

#decode

#decode_from

#encode

#encode_into

Source Files

CodecError

CodecLimits

CodecLimits::max_bytes

CodecLimits::max_collection_items

CodecLimits::max_depth

CodecLimits::new

Datum

Decoder

Decoder::ensure_finished

Decoder::limits

Decoder::new

Decoder::offset

Decoder::read_byte

Decoder::read_bytes

Decoder::read_double

Decoder::read_float

Decoder::read_int

Decoder::read_long

Decoder::read_raw

Decoder::read_string

Decoder::remaining

Encoder

Encoder::length

Encoder::new

Encoder::to_bytes

Encoder::write_byte

Encoder::write_bytes

Encoder::write_double

Encoder::write_float

Encoder::write_int

Encoder::write_long

Encoder::write_raw

Encoder::write_string

decode

decode_from

encode

encode_into