bitcoin-serialize 0.1.19

tools for serialization
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

// ---------------- [ File: bitcoin-serialize/src/wrapper.rs ]
crate::ix!();

/// Wrapper that forces (de)serialisation of the enclosed object to go
/// through a user‑supplied `Formatter`.
///
/// Construct via [`using`](crate::serialize::using).
pub struct Wrapper<'a, F, T> {
    object: &'a mut T,
    _marker: PhantomData<F>,
}

impl<'a, F, T> Wrapper<'a, F, T> {
    #[inline]
    pub const fn new(object: &'a mut T) -> Self {
        Self {
            object,
            _marker: PhantomData,
        }
    }
}

/* -------- integration with Serialize / BtcUnserialize -------- */

impl<'a, F, T, S> BtcSerialize<S> for Wrapper<'a, F, T>
where
    S: Write,
    F: ValueFormatter<T>,
{
    #[inline]
    fn serialize(&self, s: &mut S) {
        trace!(
            fmt = %std::any::type_name::<F>(),
            "Wrapper::serialize"
        );
        let mut fmt = F::default();
        fmt.ser(s, &*self.object);
    }
}

impl<'a, F, T, S> BtcUnserialize<S> for Wrapper<'a, F, T>
where
    S: Read,
    F: ValueFormatter<T>,
{
    #[inline]
    fn unserialize(&mut self, s: &mut S) {
        trace!(
            fmt = %std::any::type_name::<F>(),
            "Wrapper::unserialize"
        );
        let mut fmt = F::default();
        fmt.unser(s, &mut *self.object);
    }
}

#[cfg(test)]
mod wrapper_tests {
    use super::*;
    use std::io::Cursor;

    #[traced_test]
    fn wrapper_roundtrip_with_varint_formatter() {
        let mut value  = 300u64;
        let mut buf    = Cursor::new(Vec::<u8>::new());

        /* ----------------‑‑ serialize ‑‑---------------- */
        {
            let wrapper = Wrapper::<
                VarIntFormatter<{ VarIntMode::Default }>,
                u64,
            >::new(&mut value);
            wrapper.serialize(&mut buf);
        }

        /* zap and read back */
        value = 0;
        buf.set_position(0);
        {
            let mut wrapper = Wrapper::<
                VarIntFormatter<{ VarIntMode::Default }>,
                u64,
            >::new(&mut value);
            wrapper.unserialize(&mut buf);
        }

        assert_eq!(value, 300);
    }

    // Higher‑ranked trait bound fixes   E0106 (“missing lifetime”) ----------------
    #[allow(dead_code)]
    fn _compile_time_traits()
    where
        for<'a> Wrapper<
            'a,
            VarIntFormatter<{ VarIntMode::Default }>,
            u64,
        >: crate::serialize::BtcSerialize<Cursor<Vec<u8>>>
         + crate::unserialize::BtcUnserialize<Cursor<Vec<u8>>>,
    {}
}