moonbin
A lightweight binary serialization and deserialization library for MoonBit.
binary
serialization
moonbit
moon add hourizon/moonbin@0.1.0
Download zipAuthor
Version
0.1.0
License
MIT
Repository
Last updated
last month
Downloads
8
README#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
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.
#ByteReader
pub struct ByteReader {
data : Bytes
offset : Int
}Byte reader used by moonbin decoders.
#ByteReader::is_empty
Returns whether there are no unread byte values.
#ByteReader::len
Returns the total number of byte values in this reader.
#ByteReader::new
Creates a byte reader from an array of byte values.
#ByteReader::position
Returns the current read position.
#ByteReader::read_bytes
Reads exactly length raw bytes.
#ByteReader::read_f64
Reads an IEEE 754 double in big-endian byte order.
#ByteReader::read_i64
Reads a signed 64-bit integer in big-endian byte order.
#ByteReader::read_u32
Reads an unsigned 32-bit integer in big-endian byte order.
#ByteReader::read_u8
Reads one unsigned byte value and advances the read position.
#ByteReader::remaining
Returns how many byte values are still unread.
#ByteWriter
Byte writer used by moonbin encoders.
#ByteWriter::is_empty
Returns whether no byte values have been written.
#ByteWriter::len
Returns the number of byte values written so far.
#ByteWriter::to_bytes
Returns a copy of all bytes written so far.
#ByteWriter::write_bytes
Appends raw bytes.
#ByteWriter::write_f64
Writes an IEEE 754 double in big-endian byte order.
#ByteWriter::write_i64
Writes a signed 64-bit integer in big-endian byte order.
#ByteWriter::write_u32
Writes an unsigned 32-bit integer in big-endian byte order.
#ByteWriter::write_u8
Writes one unsigned byte value.
Returns false when value is outside the valid byte range.
#DecodeError
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
Returns a stable category name for a decode error.
#DecodeError::message
Returns a short human-readable message for a decode error.
#DecodeLimits
Resource limits applied while decoding untrusted input.
#decode
Decodes exactly one moonbin v1 value using conservative default limits.
#decode_with_limits
Decodes exactly one moonbin v1 value using explicit resource limits.
The function rejects unread trailing bytes after the top-level value.
#default_decode_limits
Returns conservative default limits for one decoded value.
#encode
Encodes one BinValue into the moonbin v1 wire format.
#error_model_name
fn error_model_name() -> StringReturns the name of the decode error model used by moonbin v1.
#value_model_name
fn value_model_name() -> StringReturns the name of the core data model used by moonbin v1.
A lightweight binary serialization and deserialization library for MoonBit.
binaryserializationmoonbit
0.1.0
MIT
Updated last month
8 downloads