packed_struct 0.3.0

Binary-level structure packing and unpacking generator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! Reserved space in a packed structure, either just zeroes or ones.

use internal_prelude::v1::*;

/// Packs into a set of zeroes. Ignores the input when unpacking.
pub type ReservedZero<B> = ReservedBits<BitZero, B>;
pub type ReservedZeroes<B> = ReservedZero<B>;

/// Packs into a set of ones. Ignores the input when unpacking.
pub type ReservedOne<B> = ReservedBits<BitOne, B>;
pub type ReservedOnes<B> = ReservedOne<B>;

pub trait ReservedBitValue {
    fn get_reserved_bit_value_byte() -> u8;
}

#[derive(Default, Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct BitOne;
impl ReservedBitValue for BitOne {
    fn get_reserved_bit_value_byte() -> u8 {
        0xFF
    }
}

#[derive(Default, Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct BitZero;
impl ReservedBitValue for BitZero {
    fn get_reserved_bit_value_byte() -> u8 {
        0
    }
}

/// Always packs into the associated bit value. Ignores the input when unpacking.
#[derive(Default, Copy, Clone, PartialEq, Serialize, Deserialize)]
pub struct ReservedBits<V, B> {
    value: V,
    bits: PhantomData<B>
}

impl<B> Debug for ReservedBits<BitZero, B> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Reserved - always 0")
    }
}

impl<B> Display for ReservedBits<BitZero, B> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Reserved - always 0")
    }
}

impl<B> Debug for ReservedBits<BitOne, B> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Reserved - always 1")
    }
}

impl<B> Display for ReservedBits<BitOne, B> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Reserved - always 1")
    }
}



use packing::*;
use types_bits::{NumberOfBits, NumberOfBytes, ByteArray};

impl<V, B> PackedStruct<<<B as NumberOfBits>::Bytes as NumberOfBytes>::AsBytes> for ReservedBits<V, B> where Self: Default, V: ReservedBitValue, B: NumberOfBits {
    fn pack(&self) -> <<B as NumberOfBits>::Bytes as NumberOfBytes>::AsBytes {
        <<<B as NumberOfBits>::Bytes as NumberOfBytes>::AsBytes>::new(V::get_reserved_bit_value_byte())
    }

    fn unpack(_src: &<<B as NumberOfBits>::Bytes as NumberOfBytes>::AsBytes) -> Result<Self, PackingError> {
        Ok(Self:: default())
    }
}

impl<V, B> PackedStructInfo for ReservedBits<V, B> where B: NumberOfBits {
    #[inline]
    fn packed_bits() -> usize {
        B::number_of_bits() as usize
    }
}

impl<V, B> PackedStructSlice for ReservedBits<V, B> where Self: Default, V: ReservedBitValue, B: NumberOfBits {
    fn pack_to_slice(&self, output: &mut [u8]) -> Result<(), PackingError> {
        for v in output.iter_mut() {
            *v = V::get_reserved_bit_value_byte();
        }
        Ok(())
    }

    fn unpack_from_slice(_src: &[u8]) -> Result<Self, PackingError> {
        Ok(Self::default())
    }

    fn packed_bytes() -> usize {
        <B as NumberOfBits>::Bytes::number_of_bytes() as usize
    }
}