tree: f09fbe53d46cb5481aae92708514ea8e5981fcf5 [path history] [tgz]
  1. .cargo-checksum.json
  2. .cargo-ok
  3. .gitignore
  4. .travis.yml
  5. COPYING
  6. Cargo.toml
  7. LICENSE-MIT
  8. Makefile
  9. README.md
  10. UNLICENSE
  11. benches/
  12. session.vim
  13. src/
vendor/byteorder-0.5.3/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 it to your Cargo.toml like so:

[dependencies]
byteorder = "0.5"

If you want to augment existing Read and Write traits, then import the extension methods like so:

extern crate byteorder;

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

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!(517, rdr.read_u16::<BigEndian>().unwrap());
assert_eq!(768, rdr.read_u16::<BigEndian>().unwrap());

no_std crates

This crate has a feature, std, that is enabled by default. To use this crate in a no_std context, add the following to your Cargo.toml:

[dependencies]
byteorder = { version = "0.5", default-features = false }