From e3ea1fc45175e1f076425dc3242aee720e0414b7 Mon Sep 17 00:00:00 2001 From: Ty Overby Date: Fri, 13 Oct 2017 08:32:50 -0700 Subject: [PATCH] remove readme.dev.md, no one was using it anyway --- readme.dev.md | 39 --------------------------------------- 1 file changed, 39 deletions(-) delete mode 100644 readme.dev.md diff --git a/readme.dev.md b/readme.dev.md deleted file mode 100644 index a0df3ca..0000000 --- a/readme.dev.md +++ /dev/null @@ -1,39 +0,0 @@ -# Bincode - - - -[![Build Status](https://travis-ci.org/TyOverby/bincode.svg)](https://travis-ci.org/TyOverby/bincode) -[![](http://meritbadge.herokuapp.com/bincode)](https://crates.io/crates/bincode) - -A compact encoder / decoder pair that uses an binary zero-fluff encoding scheme. -The size of the encoded object will be the same or smaller than the size that -the object takes up in memory in a running Rust program. - -In addition to exposing two simple funcitons that encode to Vec and decode -from Vec, binary-encode exposes a Reader/Writer API that makes it work -perfectly with other stream-based apis such as rust files, network streams, -and the [flate2-rs](https://github.com/alexcrichton/flate2-rs) compression -library. - -[Api Documentation](http://tyoverby.github.io/bincode/bincode/) - -## Example - -^code(./examples/basic.rs) - - -## Details - -The encoding (and thus decoding) proceeds unsurprisingly -- primitive -types are encoded according to the underlying `Writer`, tuples and -structs are encoded by encoding their fields one-by-one, and enums are -encoded by first writing out the tag representing the variant and -then the contents. - -However, there are some implementation details to be aware of: - -* `isize`/`usize` are encoded as `i64`/`u64`, for portability. -* enums variants are encoded as a `u32` instead that as a `uint`. - `u32` is enough for all practical uses. -* `str` is encoded as `(u64, &[u8])`, where the `u64` is the number of - bytes contained in the encoded string.