coil-msgpack

Userland MessagePack for coil. Package name is msgpack, so use msgpack::{Msgpack, MsgpackValue, MsgpackError} resolves here.

Pure Coil encode/decode. No native library. The tree is an arena of primitive vecs; a MsgpackValue is a (store, idx) handle — named-module recursive Vec<MsgpackValue> does not unify (MsgpackValue vs msgpack::MsgpackValue).

API#

use msgpack::{Msgpack, MsgpackValue, MsgpackError};

let m = Msgpack::standard();
let v = m.decode(bytes)?;
let out = m.encode(v)?;

Msgpack::standard() is the MessagePack format. Invalid input returns MsgpackError with line and column (Invalid, Io, Utf8, Number), not panic. line is 1. column is the 1-based byte offset of the failure.

decode_str is to_bytes then decode. encode_str is encode then from_bytes. MessagePack is binary, so most documents are not valid UTF-8: encode_str then returns MsgpackError::Utf8. Prefer decode / encode.

Values: nil, bool, int, float, string, binary, array, map, extension. Maps are ordered key/value children. Keys may be any value. Duplicate keys are kept in encounter order. get / has match the first string key.

Integers are i64. Encode writes the smallest family that fits. A uint64 above i64 max is MsgpackError::Number. Floats are f64. float32 widens on decode. Encode writes float64. NaN encodes as a canonical quiet NaN. +inf / -inf round-trip. Signed zero round-trips. Non-finite kind is i (1 inf, 2 nan) and flag is the inf sign. MsgpackValue::nan() and MsgpackValue::inf(neg) set that kind. Host floats may not preserve a NaN.

Extension data is raw (type, bytes), including timestamp type -1. Nesting is bounded at 256 frames.

append and put copy into the parent arena. There is no shared child across arenas.

Layout#

Consume#

spool add msgpack --git https://github.com/ardax-corp/coil-msgpack.git --rev <commit SHA>

No tags yet, so pin a commit. Without spool, pass --root ../coil-msgpack/src to coil. See docs/consume.md.

Test#

# from coil-msgpack (coil on PATH or ../coil-lang/target/debug/coil)
coil test

License#

MIT. See LICENSE.