Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
RMP - Rust MessagePack
RMP is a pure Rust MessagePack implementation.
Usage
To use rmp
, first add this to your Cargo.toml
:
[]
= "0.5.1"
Then, add this to your crate root:
extern crate rmp as msgpack;
Features
-
Convenient API
RMP is designed to be lightweight and straightforward. There are low-level API, which gives you full control on data encoding/decoding process and makes no heap allocations. On the other hand there are high-level API, which provides you convenient interface using Rust standard library and compiler reflection, allowing to encode/decode structures using
derive
attribute. -
Zero-copy value decoding
RMP allows to decode bytes from a buffer in a zero-copy manner easily and blazingly fast, while Rust static checks guarantees that the data will be valid until buffer lives.
-
Clear error handling
RMP's error system guarantees that you never receive an error enum with unreachable variant.
-
Robust and tested
This project is developed using TDD and CI, so any found bugs will be fixed without breaking existing functionality.
Examples
Let's try to encode a tuple of int and string.
extern crate rmp as msgpack;
extern crate rustc_serialize;
use Encodable;
use Encoder;
Now we have an encoded buffer, which we can decode the same way:
extern crate rmp as msgpack;
extern crate rustc_serialize;
use Decodable;
use Decoder;
RMP also allows to automatically serialize/deserialize custom structures using rustc_serialize reflection. To enable this feature, derive RustcEncodable and RustcDecodable attributes as shown in the following example:
extern crate rmp as msgpack;
extern crate rustc_serialize;
use ;
use ;
Versioning
This project adheres to Semantic Versioning. However until 1.0.0 comes there will be the following rules:
- Any API/ABI breaking changes will be notified in the changelog explicitly and results in minor version bumping.
- API extending features results in minor version bumping.
- Non-breaking bug fixes and performance improving results in patch version bumping.