README.md
1byteorder
2=========
3This crate provides convenience methods for encoding and decoding
4numbers in either big-endian or little-endian order.
5
6[](https://github.com/BurntSushi/byteorder/actions)
7[](https://crates.io/crates/byteorder)
8
9Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org/).
10
11
12### Documentation
13
14https://docs.rs/byteorder
15
16
17### Installation
18
19This crate works with Cargo and is on
20[crates.io](https://crates.io/crates/byteorder). Add it to your `Cargo.toml`
21like so:
22
23```toml
24[dependencies]
25byteorder = "1"
26```
27
28If you want to augment existing `Read` and `Write` traits, then import the
29extension methods like so:
30
31```rust
32use byteorder::{ReadBytesExt, WriteBytesExt, BigEndian, LittleEndian};
33```
34
35For example:
36
37```rust
38use std::io::Cursor;
39use byteorder::{BigEndian, ReadBytesExt};
40
41let mut rdr = Cursor::new(vec![2, 5, 3, 0]);
42// Note that we use type parameters to indicate which kind of byte order
43// we want!
44assert_eq!(517, rdr.read_u16::<BigEndian>().unwrap());
45assert_eq!(768, rdr.read_u16::<BigEndian>().unwrap());
46```
47
48### `no_std` crates
49
50This crate has a feature, `std`, that is enabled by default. To use this crate
51in a `no_std` context, add the following to your `Cargo.toml`:
52
53```toml
54[dependencies]
55byteorder = { version = "1", default-features = false }
56```
57
58
59### Alternatives
60
61Note that as of Rust 1.32, the standard numeric types provide built-in methods
62like `to_le_bytes` and `from_le_bytes`, which support some of the same use
63cases.
64
){kind=link}