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.
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 = "*"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::io::Cursor;
use byteorder::{BigEndian, ReadBytesExt};
let mut rdr = Cursor::new(vec![2, 5, 3, 0]);
// Note that we use type parameters to indicate which kind of byte order
// we want!
assert_eq!(517u16, rdr.read_as::<BigEndian>().unwrap());
assert_eq!(768u16, rdr.read_as::<BigEndian>().unwrap());