byteorder

Rust library for reading/writing numbers in big-endian and little-endian.

1,092
160
1,092
18
Rust
public

byteorder

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

Build status
crates.io

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:

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 }

Minimum Rust version policy

This crate’s minimum supported rustc version is 1.60.0.

The current policy is that the minimum Rust version required to use this crate
can be increased in minor version updates. For example, if crate 1.0 requires
Rust 1.20.0, then crate 1.0.z for all values of z will also require Rust
1.20.0 or newer. However, crate 1.y for y > 0 may require a newer minimum
version of Rust.

In general, this crate will be conservative with respect to the minimum
supported version of Rust.

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.

v0.3.3[beta]