README
- ::kindBinValue::kind
- ::is_emptyByteReader::is_empty
- ::lenByteReader::len
- ::newByteReader::new
- ::positionByteReader::position
- ::read_bytesByteReader::read_bytes
- ::read_f64ByteReader::read_f64
- ::read_i64ByteReader::read_i64
- ::read_u32ByteReader::read_u32
- ::read_u8ByteReader::read_u8
- ::remainingByteReader::remaining
- ::is_emptyByteWriter::is_empty
- ::lenByteWriter::len
- ::newByteWriter::new
- ::to_bytesByteWriter::to_bytes
- ::write_bytesByteWriter::write_bytes
- ::write_f64ByteWriter::write_f64
- ::write_i64ByteWriter::write_i64
- ::write_u32ByteWriter::write_u32
- ::write_u8ByteWriter::write_u8
- ::kindDecodeError::kind
- ::messageDecodeError::message
T
DecodeLimits
V
decode
V
decode_with_limits
V
default_decode_limits
V
encode
V
error_model_name
V
value_model_name
V
version

moonbin

A lightweight binary serialization and deserialization library for MoonBit.

binary

serialization

moonbit

Download zip

Author

hourizon

Version

0.1.0

License

MIT

Repository

github.com/hourizon/moonbin

Last updated

2 months ago

Downloads

#moonbin

moonbin 第一版以 BinValue 作为核心数据模型，编码器和解码器围绕：

BinValue <-> Bytes

展开。

#编解码示例

///|
test "encode and decode a value" {
  let value = BinValue::Object([
    ("name", BinValue::String("Hou")),
    ("age", BinValue::Int(18)),
  ])
  let bytes = encode(value)
  assert_true(decode(bytes) == Ok(value))
}

#基础值示例

///|
test "create primitive bin values" {
  inspect(BinValue::Null.kind(), content="null")
  inspect(BinValue::Bool(true).kind(), content="bool")
  inspect(BinValue::Int(42).kind(), content="int")
  inspect(BinValue::Double(3.14).kind(), content="double")
  inspect(BinValue::String("moonbin").kind(), content="string")
}

#结构化数据示例

用户结构体第一版可以手写转换为 BinValue::Object，避免依赖运行时反射：

///|
struct User {
  name : String
  age : Int
}

///|
fn User::to_bin(self : User) -> BinValue {
  BinValue::Object([
    ("name", BinValue::String(self.name)),
    ("age", BinValue::Int(self.age)),
  ])
}

///|
fn User::from_bin(value : BinValue) -> Result[User, DecodeError] {
  match value {
    BinValue::Object(
      [("name", BinValue::String(name)), ("age", BinValue::Int(age))]
    ) => Ok({ name, age })
    other => Err(DecodeError::InvalidType("User object", other.kind()))
  }
}

完整的可执行测试位于 adapter_test.mbt。

#错误模型示例

///|
test "decode error categories" {
  inspect(DecodeError::UnexpectedEOF.kind(), content="unexpected_eof")
  inspect(DecodeError::InvalidTag(255).kind(), content="invalid_tag")
}

BinValue

source

pub(all) enum BinValue {
  Null
  Bool(Bool)
  Int(Int)
  Double(Double)
  String(String)
  Bytes(Bytes)
  Array(Array[BinValue])
  Object(Array[(String, BinValue)])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Core moonbin value model.

BinValue is the stable intermediate representation that moonbin v1 encodes to bytes and decodes from bytes. User-defined structs can be mapped to this model explicitly without relying on runtime reflection.

BinValue::kind

source

fn BinValue::kind(self : BinValue) -> String

Returns the human-readable kind name of a BinValue.

ByteReader

source

pub struct ByteReader {
  data : Bytes
  offset : Int
}

Byte reader used by moonbin decoders.

ByteReader::is_empty

source

fn ByteReader::is_empty(self : ByteReader) -> Bool

Returns whether there are no unread byte values.

ByteReader::len

source

fn ByteReader::len(self : ByteReader) -> Int

Returns the total number of byte values in this reader.

ByteReader::new

source

fn ByteReader::new(data : Bytes) -> ByteReader

Creates a byte reader from an array of byte values.

ByteReader::position

source

fn ByteReader::position(self : ByteReader) -> Int

Returns the current read position.

ByteReader::read_bytes

source

fn ByteReader::read_bytes(self : ByteReader, length : Int) -> Result[Bytes, DecodeError]

Reads exactly length raw bytes.

ByteReader::read_f64

source

fn ByteReader::read_f64(self : ByteReader) -> Result[Double, DecodeError]

Reads an IEEE 754 double in big-endian byte order.

ByteReader::read_i64

source

fn ByteReader::read_i64(self : ByteReader) -> Result[Int64, DecodeError]

Reads a signed 64-bit integer in big-endian byte order.

ByteReader::read_u32

source

fn ByteReader::read_u32(self : ByteReader) -> Result[UInt, DecodeError]

Reads an unsigned 32-bit integer in big-endian byte order.

ByteReader::read_u8

source

fn ByteReader::read_u8(self : ByteReader) -> Result[Int, DecodeError]

Reads one unsigned byte value and advances the read position.

ByteReader::remaining

source

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

Returns how many byte values are still unread.

ByteWriter

source

pub struct ByteWriter {
  buffer : @moonbitlang/core/buffer.Buffer
Buffer
}

Byte writer used by moonbin encoders.

ByteWriter::is_empty

source

fn ByteWriter::is_empty(self : ByteWriter) -> Bool

Returns whether no byte values have been written.

ByteWriter::len

source

fn ByteWriter::len(self : ByteWriter) -> Int

Returns the number of byte values written so far.

ByteWriter::new

source

fn ByteWriter::new() -> ByteWriter

Creates an empty byte writer.

ByteWriter::to_bytes

source

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

Returns a copy of all bytes written so far.

ByteWriter::write_bytes

source

fn ByteWriter::write_bytes(self : ByteWriter, value : Bytes) -> Unit

Appends raw bytes.

ByteWriter::write_f64

source

fn ByteWriter::write_f64(self : ByteWriter, value : Double) -> Unit

Writes an IEEE 754 double in big-endian byte order.

ByteWriter::write_i64

source

fn ByteWriter::write_i64(self : ByteWriter, value : Int64) -> Unit

Writes a signed 64-bit integer in big-endian byte order.

ByteWriter::write_u32

source

fn ByteWriter::write_u32(self : ByteWriter, value : UInt) -> Unit

Writes an unsigned 32-bit integer in big-endian byte order.

ByteWriter::write_u8

source

fn ByteWriter::write_u8(self : ByteWriter, value : Int) -> Bool

Writes one unsigned byte value.

Returns false when value is outside the valid byte range.

DecodeError

source

pub(all) enum DecodeError {
  UnexpectedEOF
  InvalidTag(Int)
  InvalidType(String, String)
  InvalidLength(String)
  LimitExceeded(String)
  TrailingBytes(Int)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Decode errors returned by moonbin readers and decoders.

The first version keeps errors small and explicit. Later decoder modules can attach these variants to concrete byte-reading and type-checking failures.

DecodeError::kind

source

fn DecodeError::kind(self : DecodeError) -> String

Returns a stable category name for a decode error.

DecodeError::message

source

fn DecodeError::message(self : DecodeError) -> String

Returns a short human-readable message for a decode error.

DecodeLimits

source

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

Resource limits applied while decoding untrusted input.

decode

source

fn decode(bytes : Bytes) -> Result[BinValue, DecodeError]

Decodes exactly one moonbin v1 value using conservative default limits.

decode_with_limits

source

fn decode_with_limits(bytes : Bytes, limits : DecodeLimits) -> Result[BinValue, DecodeError]

Decodes exactly one moonbin v1 value using explicit resource limits.

The function rejects unread trailing bytes after the top-level value.

default_decode_limits

source

fn default_decode_limits() -> DecodeLimits

Returns conservative default limits for one decoded value.

encode

source

fn encode(value : BinValue) -> Bytes

Encodes one BinValue into the moonbin v1 wire format.

error_model_name

source

fn error_model_name() -> String

Returns the name of the decode error model used by moonbin v1.

value_model_name

source

fn value_model_name() -> String

Returns the name of the core data model used by moonbin v1.

version

source

fn version() -> String

Returns the current moonbin package version.

Source Files

Site source Report issue Packages Build queue Skills Statistics

moonbin

#moonbin

#编解码示例

#基础值示例

#结构化数据示例

#错误模型示例

#BinValue

#BinValue::kind

#ByteReader

#ByteReader::is_empty

#ByteReader::len

#ByteReader::new

#ByteReader::position

#ByteReader::read_bytes

#ByteReader::read_f64

#ByteReader::read_i64

#ByteReader::read_u32

#ByteReader::read_u8

#ByteReader::remaining

#ByteWriter

#ByteWriter::is_empty

#ByteWriter::len

#ByteWriter::new

#ByteWriter::to_bytes

#ByteWriter::write_bytes

#ByteWriter::write_f64

#ByteWriter::write_i64

#ByteWriter::write_u32

#ByteWriter::write_u8

#DecodeError

#DecodeError::kind

#DecodeError::message

#DecodeLimits

#decode

#decode_with_limits

#default_decode_limits

#encode

#error_model_name

#value_model_name

#version

Source Files

BinValue

BinValue::kind

ByteReader

ByteReader::is_empty

ByteReader::len

ByteReader::new

ByteReader::position

ByteReader::read_bytes

ByteReader::read_f64

ByteReader::read_i64

ByteReader::read_u32

ByteReader::read_u8

ByteReader::remaining

ByteWriter

ByteWriter::is_empty

ByteWriter::len

ByteWriter::new

ByteWriter::to_bytes

ByteWriter::write_bytes

ByteWriter::write_f64

ByteWriter::write_i64

ByteWriter::write_u32

ByteWriter::write_u8

DecodeError

DecodeError::kind

DecodeError::message

DecodeLimits

decode

decode_with_limits

default_decode_limits

encode

error_model_name

value_model_name

version