bin-proto 0.12.6

Conversion to/from binary for arbitrary types
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
103
104
105
106
107
108
109

use bitstream_io::{BitRead, BitWrite, Endianness};

use crate::{util, BitDecode, BitEncode, Result};
use core::mem::MaybeUninit;

struct PartialGuard<T> {
    ptr: *mut T,
    len: usize,
}

impl<T> Drop for PartialGuard<T> {
    fn drop(&mut self) {
        unsafe {
            core::ptr::drop_in_place(core::ptr::slice_from_raw_parts_mut(self.ptr, self.len));
        }
    }
}

impl<Ctx, T, const N: usize> BitDecode<Ctx> for [T; N]
where
    T: BitDecode<Ctx>,
{
    fn decode<R, E>(read: &mut R, ctx: &mut Ctx, (): ()) -> Result<Self>
    where
        R: BitRead,
        E: Endianness,
    {
        let mut array: MaybeUninit<[T; N]> = MaybeUninit::uninit();
        let mut guard = PartialGuard {
            ptr: array.as_mut_ptr().cast::<T>(),
            len: 0,
        };
        while guard.len < N {
            let item = T::decode::<_, E>(read, ctx, ())?;
            unsafe {
                guard.ptr.add(guard.len).write(item);
            }
            guard.len += 1;
        }
        core::mem::forget(guard);
        Ok(unsafe { array.assume_init() })
    }
}

impl<Ctx, T, const N: usize> BitEncode<Ctx> for [T; N]
where
    T: BitEncode<Ctx> + Sized,
{
    fn encode<W, E>(&self, write: &mut W, ctx: &mut Ctx, (): ()) -> Result<()>
    where
        W: BitWrite,
        E: Endianness,
    {
        util::encode_items::<_, E, _, _>(self.iter(), write, ctx)
    }
}

test_codec!([u8; 4]; [0, 1, 2, 3] => [0x00, 0x01, 0x02, 0x03]);
test_roundtrip!([u8; 4]);

#[cfg(test)]
mod test {
    use core::cell::RefCell;

    use bitstream_io::BigEndian;

    use crate::{BitDecodeExt, Error};

    use super::*;

    #[derive(Default)]
    struct MustDropState {
        decoded: bool,
        dropped: bool,
    }

    struct Ctx<'a>(&'a RefCell<MustDropState>);

    struct MustDrop<'a>(&'a RefCell<MustDropState>);

    impl<'a> Drop for MustDrop<'a> {
        fn drop(&mut self) {
            self.0.borrow_mut().dropped = true;
        }
    }

    impl<'a> BitDecode<Ctx<'a>> for MustDrop<'a> {
        fn decode<R, E>(_: &mut R, ctx: &mut Ctx<'a>, (): ()) -> Result<Self>
        where
            R: BitRead,
            E: Endianness,
        {
            let mut state = ctx.0.borrow_mut();
            if state.decoded {
                Err(Error::Other(""))
            } else {
                state.decoded = true;
                Ok(Self(ctx.0))
            }
        }
    }

    #[test]
    fn partial_result_dropped() {
        let state = RefCell::new(MustDropState::default());
        assert!(<[MustDrop; 2]>::decode_bytes_ctx(&[], BigEndian, &mut Ctx(&state), ()).is_err());
        assert!(state.borrow().dropped);
    }
}