Change README version pattern from * to 0.3
1 file changed
tree: 28547396988d9d55c57329ed625e9a335d88ddf3
  1. benches/
  2. src/
  3. .gitignore
  4. .travis.yml
  5. Cargo.toml
  6. COPYING
  7. LICENSE-MIT
  8. Makefile
  9. README.md
  10. session.vim
  11. UNLICENSE
README.md

This crate provides convenience methods for encoding and decoding numbers in either big-endian or little-endian order. This is meant to replace the old methods defined on the standard library Reader and Writer traits.

Build status

Dual-licensed under MIT or the UNLICENSE.

Documentation

http://burntsushi.net/rustdoc/byteorder/.

The documentation includes examples.

Installation

This crate works with Cargo and is on crates.io. The package is regularly updated. Add is to your Cargo.toml like so:

[dependencies]
byteorder = "0.3"

If you want to augment existing Reader and Writer types, then import the extension methods like so:

extern crate byteorder;

use byteorder::{ReadBytesExt, WriteBytesExt, BigEndian, LittleEndian};

Or use the ReadBytesExt/WriteBytesExt traits if you're using the new std::io module.

For example:

use std::old_io::MemReader;
use byteorder::{BigEndian, ReadBytesExt};

let mut rdr = MemReader::new(vec![2, 5, 3, 0]);
// Note that we use type parameters to indicate which kind of byte order
// we want!
assert_eq!(517, rdr.read_u16::<BigEndian>().unwrap());
assert_eq!(768, rdr.read_u16::<BigEndian>().unwrap());