| commit | 07d85e3dc662fd305d7bb3b8b5c62f6df3484aec | [log] [tgz] |
|---|---|---|
| author | Andrew Poelstra <apoelstra@wpsoftware.net> | Fri Apr 10 13:17:56 2015 -0500 |
| committer | Andrew Poelstra <apoelstra@wpsoftware.net> | Fri Apr 10 13:17:56 2015 -0500 |
| tree | c6062de42cfa0bb0f0356979483d219bad696ed6 | |
| parent | 4bab6ee59d7880293027eb0fd148fdf56cdc11e9 [diff] |
Update README.md Update `ReaderBytesExt` and `WriterBytesExt` for new names in the README
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.
This crate currently supports both the std::io and std::old_io modules.
Licensed under the UNLICENSE.
http://burntsushi.net/rustdoc/byteorder/.
The documentation includes examples.
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::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());