| commit | aab9955a3d5efc8fb3d14ccbacae4b26dd14b283 | [log] [tgz] |
|---|---|---|
| author | Sam Whited <sam@samwhited.com> | Tue Mar 28 13:20:28 2017 -0500 |
| committer | Andrew Gallant <jamslam@gmail.com> | Tue Mar 28 19:09:49 2017 -0400 |
| tree | 80eda7899c26494e67cfe15d8a1db475c22fa906 | |
| parent | 3ec105c08d1ba443f802b251f239161e771de94a [diff] |
Add examples to most methods Updates #75 Updates #76
This crate provides convenience methods for encoding and decoding numbers in either big-endian or little-endian order.
Dual-licensed under MIT or the UNLICENSE.
This crate works with Cargo and is on crates.io. Add it to your Cargo.toml like so:
[dependencies] byteorder = "1"
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 cratesThis 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 = "1", default-features = false }