Skip to content
Rust library for reading/writing numbers in big-endian and little-endian.
Rust
Branch: master
Clone or download

Latest commit

BurntSushi ci: change MSRV back to 1.12.0 in CI
Setting the pinned version to 1.28.0 was an oversight. It was most
likely the result of a copy & paste error.

We also remove doc_comment, since its MSRV is quite high.
Latest commit c0143a7 Mar 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows ci: change MSRV back to 1.12.0 in CI Mar 26, 2020
benches style: use rustfmt Feb 8, 2020
src ci: change MSRV back to 1.12.0 in CI Mar 26, 2020
.gitignore initial commit Feb 3, 2015
CHANGELOG.md changelog: add 1.3 notes and backfill others Jan 19, 2019
COPYING dual licensed under MIT and UNLICENSE Apr 15, 2015
Cargo.toml ci: change MSRV back to 1.12.0 in CI Mar 26, 2020
LICENSE-MIT dual licensed under MIT and UNLICENSE Apr 15, 2015
README.md ci: change MSRV back to 1.12.0 in CI Mar 26, 2020
UNLICENSE
build.rs style: use rustfmt Feb 8, 2020
rustfmt.toml style: use rustfmt Feb 8, 2020

README.md

byteorder

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:

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.

You can’t perform that action at this time.