berkus
/
bincode-orig
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed typos in readme

This commit is contained in:
Jan-Erik Rediger 2015-05-04 23:16:19 +02:00
parent 2c780e8119
commit 69fe369775
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -10,7 +10,7 @@ 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 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. the object takes up in memory in a running Rust program.
In addition to exposing two simple funcitons that encode to Vec<u8> and decode In addition to exposing two simple functions that encode to Vec<u8> and decode
from Vec<u8>, binary-encode exposes a Reader/Writer API that makes it work from Vec<u8>, binary-encode exposes a Reader/Writer API that makes it work
perfectly with other stream-based apis such as rust files, network streams, perfectly with other stream-based apis such as rust files, network streams,
and the [flate2-rs](https://github.com/alexcrichton/flate2-rs) compression and the [flate2-rs](https://github.com/alexcrichton/flate2-rs) compression
@ -66,7 +66,7 @@ then the contents.
However, there are some implementation details to be aware of: However, there are some implementation details to be aware of:
* `isize`/`usize` are encoded as `i64`/`u64`, for portability. * `isize`/`usize` are encoded as `i64`/`u64`, for portability.
* enums variants are encoded as a `u32` instead that as a `uint`. * enums variants are encoded as a `u32` instead of a `uint`.
`u32` is enough for all practical uses. `u32` is enough for all practical uses.
* `str` is encoded as `(u64, &[u8])`, where the `u64` is the number of * `str` is encoded as `(u64, &[u8])`, where the `u64` is the number of
bytes contained in the encoded string. bytes contained in the encoded string.