#byte #endian #big-endian #little-endian #binary

byteorder

Library for reading/writing numbers in big-endian and little-endian

53 releases (15 stable)

1.3.4 Feb 7, 2020
1.3.2 Jun 9, 2019
1.3.1 Jan 22, 2019
1.2.7 Oct 26, 2018
0.3.3 Mar 25, 2015

#4 in Encoding

Download history 156298/week @ 2019-11-01 155708/week @ 2019-11-08 161973/week @ 2019-11-15 166049/week @ 2019-11-22 156999/week @ 2019-11-29 172375/week @ 2019-12-06 164580/week @ 2019-12-13 106477/week @ 2019-12-20 107617/week @ 2019-12-27 151296/week @ 2020-01-03 172202/week @ 2020-01-10 169930/week @ 2020-01-17 159211/week @ 2020-01-24 162447/week @ 2020-01-31 198188/week @ 2020-02-07

660,062 downloads per month
Used in 10,393 crates (1,603 directly)

Unlicense OR MIT

160KB
2K SLoC

This crate provides convenience methods for encoding and decoding numbers in either big-endian or little-endian order.

Build status

Dual-licensed under MIT or the UNLICENSE.

Documentation

https://docs.rs/byteorder

Installation

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 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 = "1", default-features = false }

Alternatives

Note that as of Rust 1.32, the standard numeric types provide built-in methods like to_le_bytes and from_le_bytes, which support some of the same use cases.

No runtime deps