#![cfg_attr(not(feature = "std"), no_std)]
#[cfg(feature = "alloc")]
extern crate alloc;
#[cfg(feature = "alloc")]
use alloc::{format, vec::Vec};
#[cfg(feature = "std")]
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use bitvec::prelude::*;
use core::convert::TryInto;
pub use deku_derive::*;
pub mod attributes;
pub mod error;
pub mod prelude;
mod slice_impls;
use crate::error::DekuError;
pub trait DekuRead {
fn read(
input: &BitSlice<Msb0, u8>,
input_is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>
where
Self: Sized;
}
pub trait DekuWrite {
fn write(
&self,
output_is_le: bool,
bit_size: Option<usize>,
) -> Result<BitVec<Msb0, u8>, DekuError>;
}
pub trait DekuUpdate {
fn update(&mut self) -> Result<(), DekuError>;
}
macro_rules! ImplDekuTraits {
($typ:ty) => {
impl DekuRead for $typ {
fn read(
input: &BitSlice<Msb0, u8>,
input_is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError> {
assert!(count.is_none(), "Dev error: `count` should always be None");
let max_type_bits: usize = core::mem::size_of::<$typ>() * 8;
let bit_size = match bit_size {
None => max_type_bits,
Some(s) if s > max_type_bits => {
return Err(DekuError::Parse(format!(
"too much data: container of {} cannot hold {}",
max_type_bits, s
)))
}
Some(s) => s,
};
if input.len() < bit_size {
return Err(DekuError::Parse(format!(
"not enough data: expected {} got {}",
bit_size,
input.len()
)));
}
let (bit_slice, rest) = input.split_at(bit_size);
let bits: BitVec<Msb0, u8> = {
let mut bits = BitVec::with_capacity(bit_slice.len());
for b in bit_slice {
bits.push(*b);
}
bits.force_align();
let pad = 8 * ((bits.len() + 7) / 8) - bits.len();
if input_is_le {
let ins_index = bits.len() - (8 - pad);
for _ in 0..pad {
bits.insert(ins_index, false);
}
} else {
for _ in 0..pad {
bits.insert(0, false);
}
}
for _ in 0..(max_type_bits - bits.len()) {
if input_is_le {
bits.push(false);
} else {
bits.insert(0, false);
}
}
bits
};
let bytes = bits.into_vec();
let bytes: &[u8] = bytes.as_ref();
let value = if input_is_le {
<$typ>::from_le_bytes(bytes.try_into()?)
} else {
<$typ>::from_be_bytes(bytes.try_into()?)
};
Ok((rest, value))
}
}
impl DekuWrite for $typ {
fn write(
&self,
output_is_le: bool,
bit_size: Option<usize>,
) -> Result<BitVec<Msb0, u8>, DekuError> {
let input = if output_is_le {
self.to_le_bytes()
} else {
self.to_be_bytes()
};
let input_bits: BitVec<Msb0, u8> = input.to_vec().into();
let res_bits: BitVec<Msb0, u8> = {
if let Some(bit_size) = bit_size {
if bit_size > input_bits.len() {
return Err(DekuError::InvalidParam(format!(
"bit size {} is larger then input {}",
bit_size,
input_bits.len()
)));
}
if output_is_le {
let mut res_bits = BitVec::<Msb0, u8>::with_capacity(bit_size);
let mut remaining_bits = bit_size;
for chunk in input_bits.chunks(8) {
if chunk.len() > remaining_bits {
let bits = &chunk[chunk.len() - remaining_bits..];
for b in bits {
res_bits.push(*b);
}
break;
} else {
for b in chunk {
res_bits.push(*b);
}
}
remaining_bits -= chunk.len();
}
res_bits
} else {
input_bits[input_bits.len() - bit_size..].into()
}
} else {
input_bits
}
};
Ok(res_bits)
}
}
};
}
impl<T: DekuRead> DekuRead for Vec<T> {
fn read(
input: &BitSlice<Msb0, u8>,
input_is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>
where
Self: Sized,
{
let count = count.expect("Dev error: `count` should always be Some");
let mut res = Vec::with_capacity(count);
let mut rest = input;
for _i in 0..count {
let (new_rest, val) = <T>::read(rest, input_is_le, bit_size, None)?;
res.push(val);
rest = new_rest;
}
Ok((rest, res))
}
}
impl<T: DekuWrite> DekuWrite for Vec<T> {
fn write(
&self,
output_is_le: bool,
bit_size: Option<usize>,
) -> Result<BitVec<Msb0, u8>, DekuError> {
let mut acc = BitVec::new();
for v in self {
let r = v.write(output_is_le, bit_size)?;
acc.extend(r);
}
Ok(acc)
}
}
ImplDekuTraits!(u8);
ImplDekuTraits!(u16);
ImplDekuTraits!(u32);
ImplDekuTraits!(u64);
ImplDekuTraits!(u128);
ImplDekuTraits!(usize);
ImplDekuTraits!(i8);
ImplDekuTraits!(i16);
ImplDekuTraits!(i32);
ImplDekuTraits!(i64);
ImplDekuTraits!(i128);
ImplDekuTraits!(isize);
ImplDekuTraits!(f32);
ImplDekuTraits!(f64);
#[cfg(feature = "std")]
impl DekuRead for Ipv4Addr {
fn read(
input: &BitSlice<Msb0, u8>,
input_is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>
where
Self: Sized,
{
let (rest, ip) = u32::read(input, input_is_le, bit_size, count)?;
Ok((rest, ip.into()))
}
}
#[cfg(feature = "std")]
impl DekuWrite for Ipv4Addr {
fn write(
&self,
output_is_le: bool,
bit_size: Option<usize>,
) -> Result<BitVec<Msb0, u8>, DekuError> {
let ip: u32 = (*self).into();
ip.write(output_is_le, bit_size)
}
}
#[cfg(feature = "std")]
impl DekuRead for Ipv6Addr {
fn read(
input: &BitSlice<Msb0, u8>,
input_is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>
where
Self: Sized,
{
let (rest, ip) = u128::read(input, input_is_le, bit_size, count)?;
Ok((rest, ip.into()))
}
}
#[cfg(feature = "std")]
impl DekuWrite for Ipv6Addr {
fn write(
&self,
output_is_le: bool,
bit_size: Option<usize>,
) -> Result<BitVec<Msb0, u8>, DekuError> {
let ip: u128 = (*self).into();
ip.write(output_is_le, bit_size)
}
}
#[cfg(feature = "std")]
impl DekuWrite for IpAddr {
fn write(
&self,
output_is_le: bool,
bit_size: Option<usize>,
) -> Result<BitVec<Msb0, u8>, DekuError> {
match self {
IpAddr::V4(ipv4) => ipv4.write(output_is_le, bit_size),
IpAddr::V6(ipv6) => ipv6.write(output_is_le, bit_size),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use rstest::rstest;
#[cfg(target_endian = "little")]
static IS_LE: bool = true;
#[cfg(target_endian = "big")]
static IS_LE: bool = false;
macro_rules! TestPrimitive {
($test_name:ident, $typ:ty, $input:expr, $expected:expr) => {
#[test]
fn $test_name() {
let input = $input;
let bit_slice = input.bits::<Msb0>();
let (_rest, res_read) = <$typ>::read(bit_slice, IS_LE, None, None).unwrap();
assert_eq!($expected, res_read);
let res_write = res_read.write(IS_LE, None).unwrap().into_vec();
assert_eq!(input, res_write);
}
};
}
TestPrimitive!(test_u8, u8, vec![0xAAu8], 0xAAu8);
TestPrimitive!(test_u16, u16, vec![0xABu8, 0xCD], 0xCDAB);
TestPrimitive!(test_u32, u32, vec![0xABu8, 0xCD, 0xEF, 0xBE], 0xBEEFCDAB);
TestPrimitive!(
test_u64,
u64,
vec![0xABu8, 0xCD, 0xEF, 0xBE, 0xAB, 0xCD, 0xFE, 0xC0],
0xC0FECDABBEEFCDAB
);
TestPrimitive!(
test_u128,
u128,
vec![
0xABu8, 0xCD, 0xEF, 0xBE, 0xAB, 0xCD, 0xFE, 0xC0, 0xAB, 0xCD, 0xEF, 0xBE, 0xAB, 0xCD,
0xFE, 0xC0
],
0xC0FECDABBEEFCDABC0FECDABBEEFCDAB
);
TestPrimitive!(
test_usize,
usize,
vec![0xABu8, 0xCD, 0xEF, 0xBE, 0xAB, 0xCD, 0xFE, 0xC0],
if core::mem::size_of::<usize>() == 8 {
0xC0FECDABBEEFCDAB
} else {
0xBEEFCDAB
}
);
TestPrimitive!(test_i8, i8, vec![0xFBu8], -5);
TestPrimitive!(test_i16, i16, vec![0xFDu8, 0xFE], -259);
TestPrimitive!(test_i32, i32, vec![0x02u8, 0x3F, 0x01, 0xEF], -0x10FEC0FE);
TestPrimitive!(
test_i64,
i64,
vec![0x02u8, 0x3F, 0x01, 0xEF, 0x01, 0x3F, 0x01, 0xEF],
-0x10FEC0FE10FEC0FE
);
TestPrimitive!(
test_i128,
i128,
vec![
0x02u8, 0x3F, 0x01, 0xEF, 0x01, 0x3F, 0x01, 0xEF, 0x01, 0x3F, 0x01, 0xEF, 0x01, 0x3F,
0x01, 0xEF
],
-0x10FEC0FE10FEC0FE10FEC0FE10FEC0FE
);
TestPrimitive!(
test_isize,
isize,
vec![0x02u8, 0x3F, 0x01, 0xEF, 0x01, 0x3F, 0x01, 0xEF],
if core::mem::size_of::<isize>() == 8 {
-0x10FEC0FE10FEC0FE
} else {
-0x10FEC0FE
}
);
TestPrimitive!(test_f32, f32, vec![0xA6u8, 0x9B, 0xC4, 0xBB], -0.006);
TestPrimitive!(
test_f64,
f64,
vec![0xFAu8, 0x7E, 0x6A, 0xBC, 0x74, 0x93, 0x78, 0xBF],
-0.006
);
#[rstest(input,input_is_le,bit_size,count,expected,expected_rest,
case::normal([0xDD, 0xCC, 0xBB, 0xAA].as_ref(), IS_LE, Some(32), None, 0xAABB_CCDD, bits![Msb0, u8;]),
case::normal_bits_12_le([0b1001_0110, 0b1110_0000, 0xCC, 0xDD ].as_ref(), IS_LE, Some(12), None, 0b1110_1001_0110, bits![Msb0, u8; 0,0,0,0, 1,1,0,0,1,1,0,0, 1,1,0,1,1,1,0,1]),
case::normal_bits_12_be([0b1001_0110, 0b1110_0000, 0xCC, 0xDD ].as_ref(), !IS_LE, Some(12), None, 0b1001_0110_1110, bits![Msb0, u8; 0,0,0,0, 1,1,0,0,1,1,0,0, 1,1,0,1,1,1,0,1]),
case::normal_bit_6([0b1001_0110].as_ref(), IS_LE, Some(6), None, 0b1001_01, bits![Msb0, u8; 1,0,]),
#[should_panic(expected="Parse(\"not enough data: expected 32 got 0\")")]
case::not_enough_data([].as_ref(), IS_LE, Some(32), None, 0xFF, bits![Msb0, u8;]),
#[should_panic(expected="Parse(\"not enough data: expected 32 got 16\")")]
case::not_enough_data([0xAA, 0xBB].as_ref(), IS_LE, Some(32), None, 0xFF, bits![Msb0, u8;]),
#[should_panic(expected="Parse(\"too much data: container of 32 cannot hold 64\")")]
case::too_much_data([0xAA, 0xBB, 0xCC, 0xDD, 0xAA, 0xBB, 0xCC, 0xDD].as_ref(), IS_LE, Some(64), None, 0xFF, bits![Msb0, u8;]),
#[should_panic(expected="Dev error: `count` should always be None")]
case::dev_err_count_some([].as_ref(), IS_LE, Some(64), Some(1), 0xFF, bits![Msb0, u8;]),
)]
fn test_bit_read(
input: &[u8],
input_is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
expected: u32,
expected_rest: &BitSlice<Msb0, u8>,
) {
let bit_slice = input.bits::<Msb0>();
let (rest, res_read) = u32::read(bit_slice, input_is_le, bit_size, count).unwrap();
assert_eq!(expected, res_read);
assert_eq!(expected_rest, rest);
}
#[rstest(input,output_is_le,bit_size,expected,
case::normal_le(0xDDCC_BBAA, IS_LE, None, vec![0xAA, 0xBB, 0xCC, 0xDD]),
case::normal_be(0xDDCC_BBAA, !IS_LE, None, vec![0xDD, 0xCC, 0xBB, 0xAA]),
case::bit_size_le_smaller(0x03AB, IS_LE, Some(10), vec![0xAB, 0b11_000000]),
case::bit_size_be_smaller(0x03AB, !IS_LE, Some(10), vec![0b11, 0xAB]),
#[should_panic(expected = "InvalidParam(\"bit size 100 is larger then input 32\")")]
case::bit_size_le_bigger(0x03AB, IS_LE, Some(100), vec![0xAB, 0b11_000000]),
)]
fn test_bit_write(input: u32, output_is_le: bool, bit_size: Option<usize>, expected: Vec<u8>) {
let res_write = input.write(output_is_le, bit_size).unwrap().into_vec();
assert_eq!(expected, res_write);
}
#[rstest(input,is_le,bit_size,expected,expected_rest,expected_write,
case::normal([0xDD, 0xCC, 0xBB, 0xAA].as_ref(), IS_LE, Some(32), 0xAABB_CCDD, bits![Msb0, u8;], vec![0xDD, 0xCC, 0xBB, 0xAA]),
)]
fn test_bit_read_write(
input: &[u8],
is_le: bool,
bit_size: Option<usize>,
expected: u32,
expected_rest: &BitSlice<Msb0, u8>,
expected_write: Vec<u8>,
) {
let bit_slice = input.bits::<Msb0>();
let (rest, res_read) = u32::read(bit_slice, is_le, bit_size, None).unwrap();
assert_eq!(expected, res_read);
assert_eq!(expected_rest, rest);
let res_write = res_read.write(is_le, bit_size).unwrap().into_vec();
assert_eq!(expected_write, res_write);
}
#[rstest(input,input_is_le,bit_size,count,expected,expected_rest,
case::count_0([0xAA].as_ref(), IS_LE, Some(8), Some(0), vec![], bits![Msb0, u8; 1,0,1,0,1,0,1,0]),
case::count_1([0xAA, 0xBB].as_ref(), IS_LE, Some(8), Some(1), vec![0xAA], bits![Msb0, u8; 1,0,1,1,1,0,1,1]),
case::count_2([0xAA, 0xBB, 0xCC].as_ref(), IS_LE, Some(8), Some(2), vec![0xAA, 0xBB], bits![Msb0, u8; 1,1,0,0,1,1,0,0]),
case::bits_6([0b0110_1001, 0b1110_1001].as_ref(), IS_LE, Some(6), Some(2), vec![0b00_011010, 0b00_011110], bits![Msb0, u8; 1,0,0,1]),
#[should_panic(expected="Parse(\"too much data: container of 8 cannot hold 9\")")]
case::not_enough_data([].as_ref(), IS_LE, Some(9), Some(1), vec![], bits![Msb0, u8;]),
#[should_panic(expected="Parse(\"too much data: container of 8 cannot hold 9\")")]
case::not_enough_data([0xAA].as_ref(), IS_LE, Some(9), Some(1), vec![], bits![Msb0, u8;]),
#[should_panic(expected="Parse(\"not enough data: expected 8 got 0\")")]
case::not_enough_data([0xAA].as_ref(), IS_LE, Some(8), Some(2), vec![], bits![Msb0, u8;]),
#[should_panic(expected="Parse(\"too much data: container of 8 cannot hold 9\")")]
case::too_much_data([0xAA, 0xBB].as_ref(), IS_LE, Some(9), Some(1), vec![], bits![Msb0, u8;]),
#[should_panic(expected="Dev error: `count` should always be Some")]
case::dev_err_count_none([].as_ref(), IS_LE, Some(0), None, vec![], bits![Msb0, u8;]),
)]
fn test_vec_read(
input: &[u8],
input_is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
expected: Vec<u8>,
expected_rest: &BitSlice<Msb0, u8>,
) {
let bit_slice = input.bits::<Msb0>();
let (rest, res_read) = Vec::<u8>::read(bit_slice, input_is_le, bit_size, count).unwrap();
assert_eq!(expected, res_read);
assert_eq!(expected_rest, rest);
}
#[rstest(input,output_is_le,bit_size,expected,
case::normal(vec![0xAABB, 0xCCDD], IS_LE, None, vec![0xBB, 0xAA, 0xDD, 0xCC]),
)]
fn test_vec_write(
input: Vec<u16>,
output_is_le: bool,
bit_size: Option<usize>,
expected: Vec<u8>,
) {
let res_write = input.write(output_is_le, bit_size).unwrap().into_vec();
assert_eq!(expected, res_write);
}
#[rstest(input,is_le,bit_size,count,expected,expected_rest,expected_write,
case::normal_le([0xAA, 0xBB, 0xCC, 0xDD].as_ref(), IS_LE, Some(16), Some(2), vec![0xBBAA, 0xDDCC], bits![Msb0, u8;], vec![0xAA, 0xBB, 0xCC, 0xDD]),
case::normal_be([0xAA, 0xBB, 0xCC, 0xDD].as_ref(), !IS_LE, Some(16), Some(2), vec![0xAABB, 0xCCDD], bits![Msb0, u8;], vec![0xAA, 0xBB, 0xCC, 0xDD]),
)]
fn test_vec_read_write(
input: &[u8],
is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
expected: Vec<u16>,
expected_rest: &BitSlice<Msb0, u8>,
expected_write: Vec<u8>,
) {
let bit_slice = input.bits::<Msb0>();
let (rest, res_read) = Vec::<u16>::read(bit_slice, is_le, bit_size, count).unwrap();
assert_eq!(expected, res_read);
assert_eq!(expected_rest, rest);
let res_write: Vec<u8> = res_read.write(is_le, bit_size).unwrap().into_vec();
assert_eq!(expected_write, res_write);
assert_eq!(input[..expected_write.len()].to_vec(), expected_write);
}
#[rstest(input,is_le,bit_size,count,expected,expected_rest,
case::normal_le([237,160,254,145].as_ref(), IS_LE, None, None, Ipv4Addr::new(145,254,160,237), bits![Msb0, u8;]),
case::normal_be([145,254,160,237].as_ref(), !IS_LE, None, None, Ipv4Addr::new(145,254,160,237), bits![Msb0, u8;]),
)]
fn test_ipv4(
input: &[u8],
is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
expected: Ipv4Addr,
expected_rest: &BitSlice<Msb0, u8>,
) {
let bit_slice = input.bits::<Msb0>();
let (rest, res_read) = Ipv4Addr::read(bit_slice, is_le, bit_size, count).unwrap();
assert_eq!(expected, res_read);
assert_eq!(expected_rest, rest);
let res_write: Vec<u8> = res_read.write(is_le, bit_size).unwrap().into_vec();
assert_eq!(input.to_vec(), res_write);
}
#[rstest(input,is_le,bit_size,count,expected,expected_rest,
case::normal_le([0xFF, 0x02, 0x0A, 0xC0, 0xFF, 0xFF,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00].as_ref(),
IS_LE, None, None, Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x02ff), bits![Msb0, u8;]),
case::normal_be([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0xFF, 0xFF, 0xC0, 0x0A, 0x02, 0xFF].as_ref(),
!IS_LE, None, None, Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x02ff), bits![Msb0, u8;]),
)]
fn test_ipv6(
input: &[u8],
is_le: bool,
bit_size: Option<usize>,
count: Option<usize>,
expected: Ipv6Addr,
expected_rest: &BitSlice<Msb0, u8>,
) {
let bit_slice = input.bits::<Msb0>();
let (rest, res_read) = Ipv6Addr::read(bit_slice, is_le, bit_size, count).unwrap();
assert_eq!(expected, res_read);
assert_eq!(expected_rest, rest);
let res_write: Vec<u8> = res_read.write(is_le, bit_size).unwrap().into_vec();
assert_eq!(input.to_vec(), res_write);
}
#[test]
fn test_ip_addr_write() {
let ip_addr = IpAddr::V4(Ipv4Addr::new(145, 254, 160, 237));
let ret_write = ip_addr.write(true, None).unwrap().into_vec();
assert_eq!(vec![237, 160, 254, 145], ret_write);
let ip_addr = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x02ff));
let ret_write = ip_addr.write(true, None).unwrap().into_vec();
assert_eq!(
vec![
0xFF, 0x02, 0x0A, 0xC0, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00
],
ret_write
);
}
}