#![crate_name = "byteorder"]
#![doc(html_root_url = "http://burntsushi.net/rustdoc/byteorder")]
#![deny(missing_docs)]
#![allow(unused_features)] #![feature(core, io, test)]
use std::old_io::IoResult;
use std::mem::transmute;
macro_rules! lg {
($($arg:tt)*) => ({
let _ = ::std::old_io::stderr().write_str(&*format!($($arg)*));
let _ = ::std::old_io::stderr().write_str("\n");
});
}
pub trait ByteOrder {
fn read_u16(buf: &[u8]) -> u16;
fn read_u32(buf: &[u8]) -> u32;
fn read_u64(buf: &[u8]) -> u64;
fn write_u16(buf: &mut [u8], n: u16);
fn write_u32(buf: &mut [u8], n: u32);
fn write_u64(buf: &mut [u8], n: u64);
fn read_i16(buf: &[u8]) -> i16 {
<Self as ByteOrder>::read_u16(buf) as i16
}
fn read_i32(buf: &[u8]) -> i32 {
<Self as ByteOrder>::read_u32(buf) as i32
}
fn read_i64(buf: &[u8]) -> i64 {
<Self as ByteOrder>::read_u64(buf) as i64
}
fn read_f32(buf: &[u8]) -> f32 {
unsafe { transmute(<Self as ByteOrder>::read_u32(buf)) }
}
fn read_f64(buf: &[u8]) -> f64 {
unsafe { transmute(<Self as ByteOrder>::read_u64(buf)) }
}
fn write_i16(buf: &mut [u8], n: i16) {
<Self as ByteOrder>::write_u16(buf, n as u16)
}
fn write_i32(buf: &mut [u8], n: i32) {
<Self as ByteOrder>::write_u32(buf, n as u32)
}
fn write_i64(buf: &mut [u8], n: i64) {
<Self as ByteOrder>::write_u64(buf, n as u64)
}
fn write_f32(buf: &mut [u8], n: f32) {
<Self as ByteOrder>::write_u32(buf, unsafe { transmute(n) })
}
fn write_f64(buf: &mut [u8], n: f64) {
<Self as ByteOrder>::write_u64(buf, unsafe { transmute(n) })
}
}
pub trait ReaderBytesExt: Reader + Sized {
fn read_u8(&mut self) -> IoResult<u8> {
let mut buf = [0; 1];
try!(read_full(self, &mut buf));
Ok(buf[0])
}
fn read_i8(&mut self) -> IoResult<i8> {
let mut buf = [0; 1];
try!(read_full(self, &mut buf));
Ok(buf[0] as i8)
}
fn read_u16<T: ByteOrder>(&mut self) -> IoResult<u16> {
let mut buf = [0; 2];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_u16(&buf))
}
fn read_i16<T: ByteOrder>(&mut self) -> IoResult<i16> {
let mut buf = [0; 2];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_i16(&buf))
}
fn read_u32<T: ByteOrder>(&mut self) -> IoResult<u32> {
let mut buf = [0; 4];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_u32(&buf))
}
fn read_i32<T: ByteOrder>(&mut self) -> IoResult<i32> {
let mut buf = [0; 4];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_i32(&buf))
}
fn read_u64<T: ByteOrder>(&mut self) -> IoResult<u64> {
let mut buf = [0; 8];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_u64(&buf))
}
fn read_i64<T: ByteOrder>(&mut self) -> IoResult<i64> {
let mut buf = [0; 8];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_i64(&buf))
}
fn read_f32<T: ByteOrder>(&mut self) -> IoResult<f32> {
let mut buf = [0; 4];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_f32(&buf))
}
fn read_f64<T: ByteOrder>(&mut self) -> IoResult<f64> {
let mut buf = [0; 8];
try!(read_full(self, &mut buf));
Ok(<T as ByteOrder>::read_f64(&buf))
}
}
impl<R: Reader> ReaderBytesExt for R {}
fn read_full<R: Reader>(rdr: &mut R, buf: &mut [u8]) -> IoResult<()> {
let mut n = 0us;
while n < buf.len() {
n += try!(rdr.read(&mut buf[n..]));
}
Ok(())
}
pub trait WriterBytesExt: Writer + Sized {
fn write_u8(&mut self, n: u8) -> IoResult<()> {
self.write_all(&[n])
}
fn write_i8(&mut self, n: i8) -> IoResult<()> {
self.write_all(&[n as u8])
}
fn write_u16<T: ByteOrder>(&mut self, n: u16) -> IoResult<()> {
let mut buf = [0; 2];
<T as ByteOrder>::write_u16(&mut buf, n);
self.write_all(&buf)
}
fn write_i16<T: ByteOrder>(&mut self, n: i16) -> IoResult<()> {
let mut buf = [0; 2];
<T as ByteOrder>::write_i16(&mut buf, n);
self.write_all(&buf)
}
fn write_u32<T: ByteOrder>(&mut self, n: u32) -> IoResult<()> {
let mut buf = [0; 4];
<T as ByteOrder>::write_u32(&mut buf, n);
self.write_all(&buf)
}
fn write_i32<T: ByteOrder>(&mut self, n: i32) -> IoResult<()> {
let mut buf = [0; 4];
<T as ByteOrder>::write_i32(&mut buf, n);
self.write_all(&buf)
}
fn write_u64<T: ByteOrder>(&mut self, n: u64) -> IoResult<()> {
let mut buf = [0; 8];
<T as ByteOrder>::write_u64(&mut buf, n);
self.write_all(&buf)
}
fn write_i64<T: ByteOrder>(&mut self, n: i64) -> IoResult<()> {
let mut buf = [0; 8];
<T as ByteOrder>::write_i64(&mut buf, n);
self.write_all(&buf)
}
fn write_f32<T: ByteOrder>(&mut self, n: f32) -> IoResult<()> {
let mut buf = [0; 4];
<T as ByteOrder>::write_f32(&mut buf, n);
self.write_all(&buf)
}
fn write_f64<T: ByteOrder>(&mut self, n: f64) -> IoResult<()> {
let mut buf = [0; 8];
<T as ByteOrder>::write_f64(&mut buf, n);
self.write_all(&buf)
}
}
impl<W: Writer> WriterBytesExt for W {}
#[allow(missing_copy_implementations)] pub enum BigEndian {}
#[allow(missing_copy_implementations)] pub enum LittleEndian {}
macro_rules! read_num_bytes {
($ty:ty, $size:expr, $src:expr, $which:ident) => ({
use std::num::Int;
use std::ptr::copy_nonoverlapping_memory;
assert!($src.len() >= $size); let mut out = [0u8; $size];
let ptr_out = out.as_mut_ptr();
unsafe {
copy_nonoverlapping_memory(ptr_out, $src.as_ptr(), $size);
(*(ptr_out as *const $ty)).$which()
}
});
}
macro_rules! write_num_bytes {
($ty:ty, $size:expr, $n:expr, $dst:expr, $which:ident) => ({
use std::num::Int;
use std::ptr::copy_nonoverlapping_memory;
assert!($dst.len() >= $size); unsafe {
let bytes = (&transmute::<_, [u8; $size]>($n.$which())).as_ptr();
copy_nonoverlapping_memory($dst.as_mut_ptr(), bytes, $size);
}
});
}
impl ByteOrder for BigEndian {
fn read_u16(buf: &[u8]) -> u16 {
read_num_bytes!(u16, 2, buf, to_be)
}
fn read_u32(buf: &[u8]) -> u32 {
read_num_bytes!(u32, 4, buf, to_be)
}
fn read_u64(buf: &[u8]) -> u64 {
read_num_bytes!(u64, 8, buf, to_be)
}
fn write_u16(buf: &mut [u8], n: u16) {
write_num_bytes!(u16, 2, n, buf, to_be);
}
fn write_u32(buf: &mut [u8], n: u32) {
write_num_bytes!(u32, 4, n, buf, to_be);
}
fn write_u64(buf: &mut [u8], n: u64) {
write_num_bytes!(u64, 8, n, buf, to_be);
}
}
impl ByteOrder for LittleEndian {
fn read_u16(buf: &[u8]) -> u16 {
read_num_bytes!(u16, 2, buf, to_le)
}
fn read_u32(buf: &[u8]) -> u32 {
read_num_bytes!(u32, 4, buf, to_le)
}
fn read_u64(buf: &[u8]) -> u64 {
read_num_bytes!(u64, 8, buf, to_le)
}
fn write_u16(buf: &mut [u8], n: u16) {
write_num_bytes!(u16, 2, n, buf, to_le);
}
fn write_u32(buf: &mut [u8], n: u32) {
write_num_bytes!(u32, 4, n, buf, to_le);
}
fn write_u64(buf: &mut [u8], n: u64) {
write_num_bytes!(u64, 8, n, buf, to_le);
}
}
#[cfg(test)]
mod test {
extern crate quickcheck;
extern crate rand;
use test::rand::thread_rng;
use test::quickcheck::{QuickCheck, StdGen, Testable};
fn qc_sized<A: Testable>(f: A, size: u64) {
QuickCheck::new()
.gen(StdGen::new(thread_rng(), size as usize))
.tests(1_00)
.max_tests(10_000)
.quickcheck(f);
}
macro_rules! qc_byte_order {
($name:ident, $ty_int:ident, $max:ident,
$read:ident, $write:ident) => (
mod $name {
use std::$ty_int;
use {BigEndian, ByteOrder, LittleEndian};
use super::qc_sized;
#[test]
fn big_endian() {
fn prop(n: $ty_int) -> bool {
let mut buf = [0; 8];
<BigEndian as ByteOrder>::$write(&mut buf, n);
n == <BigEndian as ByteOrder>::$read(&mut buf)
}
qc_sized(prop as fn($ty_int) -> bool,
$ty_int::$max as u64 - 1);
}
#[test]
fn little_endian() {
fn prop(n: $ty_int) -> bool {
let mut buf = [0; 8];
<LittleEndian as ByteOrder>::$write(&mut buf, n);
n == <LittleEndian as ByteOrder>::$read(&mut buf)
}
qc_sized(prop as fn($ty_int) -> bool,
$ty_int::$max as u64 - 1);
}
}
);
}
qc_byte_order!(prop_u16, u16, MAX, read_u16, write_u16);
qc_byte_order!(prop_i16, i16, MAX, read_i16, write_i16);
qc_byte_order!(prop_u32, u32, MAX, read_u32, write_u32);
qc_byte_order!(prop_i32, i32, MAX, read_i32, write_i32);
qc_byte_order!(prop_u64, u64, MAX, read_u64, write_u64);
qc_byte_order!(prop_i64, i64, MAX, read_i64, write_i64);
qc_byte_order!(prop_f32, f32, MAX_VALUE, read_f32, write_f32);
qc_byte_order!(prop_f64, f64, MAX_VALUE, read_f64, write_f64);
macro_rules! qc_bytes_ext {
($name:ident, $ty_int:ident,
$max:ident, $read:ident, $write:ident) => (
mod $name {
use std::old_io::MemReader;
use std::$ty_int;
use {ReaderBytesExt, WriterBytesExt, BigEndian, LittleEndian};
use super::qc_sized;
#[test]
fn big_endian() {
fn prop(n: $ty_int) -> bool {
let mut wtr = vec![];
wtr.$write::<BigEndian>(n).unwrap();
let mut rdr = MemReader::new(wtr);
n == rdr.$read::<BigEndian>().unwrap()
}
qc_sized(prop as fn($ty_int) -> bool,
$ty_int::$max as u64 - 1);
}
#[test]
fn little_endian() {
fn prop(n: $ty_int) -> bool {
let mut wtr = vec![];
wtr.$write::<LittleEndian>(n).unwrap();
let mut rdr = MemReader::new(wtr);
n == rdr.$read::<LittleEndian>().unwrap()
}
qc_sized(prop as fn($ty_int) -> bool,
$ty_int::$max as u64 - 1);
}
}
);
}
qc_bytes_ext!(prop_ext_u16, u16, MAX, read_u16, write_u16);
qc_bytes_ext!(prop_ext_i16, i16, MAX, read_i16, write_i16);
qc_bytes_ext!(prop_ext_u32, u32, MAX, read_u32, write_u32);
qc_bytes_ext!(prop_ext_i32, i32, MAX, read_i32, write_i32);
qc_bytes_ext!(prop_ext_u64, u64, MAX, read_u64, write_u64);
qc_bytes_ext!(prop_ext_i64, i64, MAX, read_i64, write_i64);
qc_bytes_ext!(prop_ext_f32, f32, MAX_VALUE, read_f32, write_f32);
qc_bytes_ext!(prop_ext_f64, f64, MAX_VALUE, read_f64, write_f64);
macro_rules! too_small {
($name:ident, $maximally_small:expr, $zero:expr,
$read:ident, $write:ident) => (
mod $name {
use {BigEndian, ByteOrder, LittleEndian};
#[test]
#[should_fail]
fn read_big_endian() {
let buf = [0; $maximally_small];
<BigEndian as ByteOrder>::$read(&buf);
}
#[test]
#[should_fail]
fn read_little_endian() {
let buf = [0; $maximally_small];
<LittleEndian as ByteOrder>::$read(&buf);
}
#[test]
#[should_fail]
fn write_big_endian() {
let mut buf = [0; $maximally_small];
<BigEndian as ByteOrder>::$write(&mut buf, $zero);
}
#[test]
#[should_fail]
fn write_little_endian() {
let mut buf = [0; $maximally_small];
<LittleEndian as ByteOrder>::$write(&mut buf, $zero);
}
}
);
}
too_small!(small_u16, 1, 0, read_u16, write_u16);
too_small!(small_i16, 1, 0, read_i16, write_i16);
too_small!(small_u32, 3, 0, read_u32, write_u32);
too_small!(small_i32, 3, 0, read_i32, write_i32);
too_small!(small_u64, 7, 0, read_u64, write_u64);
too_small!(small_i64, 7, 0, read_i64, write_i64);
too_small!(small_f32, 3, 0.0, read_f32, write_f32);
too_small!(small_f64, 7, 0.0, read_f64, write_f64);
}
#[cfg(test)]
mod bench {
extern crate test;
macro_rules! bench_num {
($ty:ident, $max:ident,
$read:ident, $write:ident, $size:expr, $data:expr) => (
mod $ty {
use std::$ty;
use {ByteOrder, BigEndian, LittleEndian};
use super::test::Bencher;
use super::test::black_box as bb;
const NITER: usize = 100_000;
#[bench]
fn read_big_endian(b: &mut Bencher) {
let buf = $data;
b.iter(|| {
for _ in 0..NITER {
bb(<BigEndian as ByteOrder>::$read(&buf));
}
});
}
#[bench]
fn read_little_endian(b: &mut Bencher) {
let buf = $data;
b.iter(|| {
for _ in 0..NITER {
bb(<LittleEndian as ByteOrder>::$read(&buf));
}
});
}
#[bench]
fn write_big_endian(b: &mut Bencher) {
let mut buf = $data;
let n = $ty::$max;
b.iter(|| {
for _ in 0..NITER {
bb(<BigEndian as ByteOrder>::$write(&mut buf, n));
}
});
}
#[bench]
fn write_little_endian(b: &mut Bencher) {
let mut buf = $data;
let n = $ty::$max;
b.iter(|| {
for _ in 0..NITER {
bb(<LittleEndian as ByteOrder>::$write(&mut buf,
n));
}
});
}
}
);
}
bench_num!(u16, MAX, read_u16, write_u16, 2, [1, 2]);
bench_num!(i16, MAX, read_i16, write_i16, 2, [1, 2]);
bench_num!(u32, MAX, read_u32, write_u32, 4, [1, 2, 3, 4]);
bench_num!(i32, MAX, read_i32, write_i32, 4, [1, 2, 3, 4]);
bench_num!(u64, MAX, read_u64, write_u64, 8, [1, 2, 3, 4, 5, 6, 7, 8]);
bench_num!(i64, MAX, read_i64, write_i64, 8, [1, 2, 3, 4, 5, 6, 7, 8]);
bench_num!(f32, MAX_VALUE, read_f32, write_f32, 4, [1, 2, 3, 4]);
bench_num!(f64, MAX_VALUE, read_f64, write_f64, 8,
[1, 2, 3, 4, 5, 6, 7, 8]);
}