msgpack_simple

Crates.iomsgpack_simple
lib.rsmsgpack_simple
version1.0.2
sourcesrc
created_at2019-01-31 20:56:18.062565
updated_at2020-08-29 15:35:32.12737
descriptionSimplified, easy to use, pure Rust MessagePack implementation focused on handling dynamic data structures.
homepage
repositoryhttps://github.com/b3nsn0w/msgpack_simple/
max_upload_size
id111879
size55,182
Ben Snow (b3nsn0w)

documentation

README

Simplified, easy to use, pure Rust MessagePack implementation focused on handling dynamic data structures.

Documentation

Example usage:

use msgpack_simple::{MsgPack, MapElement, Extension};

let message = MsgPack::Map(vec![
    MapElement {
        key: MsgPack::String(String::from("hello")),
        value: MsgPack::Int(42)
    },
    MapElement {
        key: MsgPack::String(String::from("world")),
        value: MsgPack::Array(vec![
            MsgPack::Boolean(true),
            MsgPack::Nil,
            MsgPack::Binary(vec![0x42, 0xff]),
            MsgPack::Extension(Extension {
                type_id: 2,
                value: vec![0x32, 0x4a, 0x67, 0x11]
            })
        ])
    }
]);

let encoded = message.encode(); // encoded is a Vec<u8>
let decoded = MsgPack::parse(&encoded).unwrap();

println!("{}", decoded);
assert_eq!(message, decoded);
assert!(message.is_map());

let mut map = message.as_map().unwrap(); // map is a Vec<MapElement>
let second_element = map.remove(1);

assert!(second_element.key.is_string());
assert_eq!(second_element.key.as_string().unwrap(), "world".to_string());

assert!(second_element.value.is_array());

let mut array = second_element.value.as_array().unwrap(); // array is a Vec<MsgPack>
let nil = array.remove(1);

assert!(nil.is_nil());

This library abstracts MessagePack data into a single MsgPack enum which can correspond to any encodable data type and handle nested data structures dynamically. It's not as performant as static solutions, for that, mneumann's rust-msgpack and 3Hren's RMP crates are recommended, but it is able to parse messages without full prior knowledge of their structure.

For more details, check out the documentation.

Contributing, license, and other stuff

As always, pull requests, bug reports, suggestions, and other kinds of improvements are welcome. Just be respectful towards each other, and maybe run or create tests as appropriate.

msgpack_simple is available under the MIT license.

Commit count: 4

cargo fmt