🥮 mooncakes.io

    moonwire

    Deterministic length-prefixed binary framing for MoonBit

    binary-protocol
    framing
    embedded
    moonbit
    Download zip
    Version
    0.1.0
    License
    MIT
    Repository
    Last updated
    2 hours ago
    Downloads
    1

    #MoonWire

    MoonWire 是一个使用 MoonBit 编写的轻量、确定性的二进制帧编解码库，适合 MoonBit 应用、嵌入式通信原型和测试夹具。

    #功能

    MoonWire 编解码一种固定格式的应用层帧：

    MW magic | version | kind | 3 字节大端 payload 长度 | checksum | payload

    提供以下能力：

    • 创建带版本和类型的帧；
    • 将帧编码为字节序列；
    • 从字节序列解码一个完整帧；
    • 检查 magic、长度和 checksum；
    • 返回稳定的错误标识，方便测试和上层处理；
    • 使用纯 MoonBit API，支持多个 MoonBit 编译目标。

    #使用示例

    let frame = @moonwire.Frame::new(1, 7, b"hello").unwrap()
    let wire = @moonwire.encode(frame)
    let same = @moonwire.decode(wire).unwrap()

    #功能边界

    MoonWire 只负责应用层二进制帧的编码和解码，不负责：

    • TCP、UDP 或其他传输层通信；
    • 流式数据重组；
    • 加密、认证或压缩；
    • 硬件控制；
    • HTTP、JSON-RPC 或数据库协议；
    • 多种协议格式之间的自动协商。

    #验证

    在项目根目录执行：

    moon fmt --check
moon check --target wasm-gc --deny-warn
moon check --target wasm --deny-warn
moon check --target js --deny-warn
moon check --target native --deny-warn
moon test --target wasm-gc

    #项目结构

    • moonwire.mbt：核心帧类型、编码器和解码器；
    • moonwire_test.mbt：正常路径和错误输入测试；
    • moon.mod、moon.pkg：MoonBit 项目配置；
    • .github/workflows/ci.yml：持续集成配置；
    • LICENSE：MIT 许可证。

    #许可证

    本项目采用 MIT 许可证，详见 LICENSE。

    Frame

    source
    pub struct Frame {
      version : Int
      kind : Int
      payload : Bytes
    }

    A decoded application frame.

    Frame::kind

    source
    fn Frame::kind(self : Frame) -> Int

    Frame::new

    source
    fn Frame::new(version : Int, kind : Int, payload : Bytes) -> Result[Frame, String]

    Frame::payload

    source
    fn Frame::payload(self : Frame) -> Bytes

    Frame::version

    source
    fn Frame::version(self : Frame) -> Int

    decode

    source
    fn decode(data : Bytes) -> Result[Frame, String]

    encode

    source
    fn encode(frame : Frame) -> Bytes

    Encode as magic(2), version(1), kind(1), length(3), payload.

    explain

    source
    fn explain(error : String) -> String

    Return a stable human-readable error category.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io