Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / byteorder / c25f0f9db85c3de547053db8a36e208930c836e0
commitc25f0f9db85c3de547053db8a36e208930c836e0[log] [tgz]
authorAndrew Gallant <jamslam@gmail.com>Mon Mar 04 16:20:42 2019 -0500
committerAndrew Gallant <jamslam@gmail.com>Mon Mar 04 16:20:42 2019 -0500
tree8ec4abc30ab7225f8d6d1ef53eb2cb986a1a4e99
parent64c03fb383289f8e42b2892bf72297879777a238 [diff]
doc: fix overflowing literals in doc tests

These were likely a result of copy & pasting example code. There is
actually an overflowing literal lint that would normally catch this, but
doc tests do not need to output lint warnings by default.

Rust 2018 made overflowing literals deny-by-default, and Rust 2015 just
recently did the same---even though it's a breaking change. That in turn
caused the doc tests to fail, and thus, we finally noticed it.

Fixes #144
1 file changed
tree: 8ec4abc30ab7225f8d6d1ef53eb2cb986a1a4e99
  1. benches/
  2. ci/
  3. src/
  4. .gitignore
  5. .travis.yml
  6. build.rs
  7. Cargo.toml
  8. CHANGELOG.md
  9. COPYING
  10. LICENSE-MIT
  11. README.md
  12. UNLICENSE
README.md

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 }