digestible 0.2.3

A more dynamic Hash and Hasher trait for Rust
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

use byteorder::ByteOrder;
macro_rules! write_doc {
    ($num:ty, $endian_write:ident) => {
        write_doc!($num, $endian_write, "")
    };
    ($num:ty, $endian_write:ident,  float) => {
        write_doc!($num, $endian_write, "Please Read [Floats 32 and f64](digestible/index.html#floats-f32-f64)")
    };
    ($num:ty, $endian_write:ident, $other:literal) => {
        concat!("Writes a [`", stringify!($num), "`] to the underlying writer.",
                    "<h5>Default Implementation</h5>
                    Creates a byte array of the size with size of the type. ",
                    "Then calls [`ByteOrder::", stringify!($endian_write), "`](byteorder::ByteOrder::", stringify!($endian_write), ")
                    with the data and the data array is passed to [`write`](DigestWriter::write)",
                    $other
        )
    };

}
macro_rules! define_write {
     (
            #[doc = $doc:expr]
            ($num:ty, $endian_write:ident, $size:literal, $fun_name:ident)
     ) => {
        #[doc = $doc]
        #[inline(always)]
        fn $fun_name<B: ByteOrder>(&mut self, data: $num) {
            let mut buffer = [0u8; $size];
            B::$endian_write(&mut buffer, data);
            self.write(&buffer);
        }
    };
    ($(($num:ty, $endian_write:ident, $size:literal, $fun_name:ident)),*) => {
        $(

                define_write!(
                    #[doc = write_doc!($num, $endian_write, $size)]
                    ($num, $endian_write, $size, $fun_name)
                );

        )*
    };
}
macro_rules! deref_and_call_inner {
    ($fnName:ident, $fnParam:ident: $fnType:ty) => {
        #[inline(always)]
        fn $fnName(&mut self, $fnParam: $fnType) {
            (**self).$fnName($fnParam)
        }
    };
    ($fnName:ident,ByteOrder, $fnParam:ident: $fnType:ty) => {
        #[inline(always)]
        fn $fnName<B: byteorder::ByteOrder>(&mut self, $fnParam: $fnType) {
            (**self).$fnName::<B>($fnParam)
        }
    };
    () => {
        deref_and_call_inner!(write, data: &[u8]);
        deref_and_call_inner!(write_bool, data: bool);
        deref_and_call_inner!(write_u8, data: u8);
        deref_and_call_inner!(write_i8, data: i8);
        deref_and_call_inner!(write_str, data: &str);
        deref_and_call_inner!(write_usize,ByteOrder, data: usize);
        deref_and_call_inner!(write_isize, ByteOrder, data: isize);
        deref_and_call_inner!(write_u16,ByteOrder, data: u16);
        deref_and_call_inner!(write_u32,ByteOrder, data: u32);
        deref_and_call_inner!(write_u64,ByteOrder, data: u64);
        deref_and_call_inner!(write_u128,ByteOrder, data: u128);
        deref_and_call_inner!(write_i16,ByteOrder, data: i16);
        deref_and_call_inner!(write_i32,ByteOrder, data: i32);
        deref_and_call_inner!(write_i64,ByteOrder, data: i64);
        deref_and_call_inner!(write_i128,ByteOrder, data: i128);
        deref_and_call_inner!(write_f32,ByteOrder, data: f32);
        deref_and_call_inner!(write_f64,ByteOrder, data: f64);

    };
}
/// A writer trait targeting an in memory buffer or the Digester itself.
///
/// This is what is passed into [`Digestible::digest`](crate::Digestible::digest)
///
/// The default implementation just converts the data types to bytes and calls [`write`](DigestWriter::write)
/// ## Default Implementations
/// - [`Vec<u8>`] requires 'alloc'
/// - [bytes::BytesMut] (requires the `bytes` feature)
pub trait DigestWriter {
    /// Writes the data to the underlying writer.
    ///
    /// This is the only function that is required to be implemented.
    fn write(&mut self, data: &[u8]);
    /// Writes a [`bool`](bool) to the underlying writer
    ///
    /// # Default Implementation
    /// Casts the bool to a u8 then puts it in a byte array calls [`write`](DigestWriter::write)
    #[inline(always)]
    fn write_bool(&mut self, data: bool) {
        self.write(&[data as u8]);
    }
    /// Writes a [`u8`](u8) to the underlying writer
    ///
    /// # Default Implementation
    /// Puts the u8 in a byte array then calls [`write`](DigestWriter::write)
    #[inline(always)]
    fn write_u8(&mut self, data: u8) {
        self.write(&[data]);
    }

    /// Writes a [`i8`](i8) to the underlying writer
    ///
    /// # Default Implementation
    /// Casts to u8 then puts in a byte array then calls [`write`](DigestWriter::write)
    #[inline(always)]
    fn write_i8(&mut self, data: i8) {
        self.write(&[data as u8]);
    }

    /// Writes a [`str`](core::str) to the underlying writer
    ///
    /// # Default Implementation
    /// Calls [`write`](DigestWriter::write) with the bytes of the string
    #[inline(always)]
    fn write_str(&mut self, data: &str) {
        self.write(data.as_bytes());
    }
    #[doc = write_doc!(isize, write_uint)]
    #[inline(always)]
    fn write_usize<B: ByteOrder>(&mut self, data: usize) {
        let mut buffer = [0u8; core::mem::size_of::<usize>()];
        B::write_uint(&mut buffer, data as u64, core::mem::size_of::<usize>());
        self.write(&buffer);
    }
    #[doc = write_doc!(isize, write_int)]
    #[inline(always)]
    fn write_isize<B: ByteOrder>(&mut self, data: isize) {
        let mut buffer = [0u8; core::mem::size_of::<isize>()];
        B::write_int(&mut buffer, data as i64, core::mem::size_of::<isize>());
        self.write(&buffer);
    }
    define_write!(
        (u16, write_u16, 2, write_u16),
        (u32, write_u32, 4, write_u32),
        (u64, write_u64, 8, write_u64),
        (u128, write_u128, 16, write_u128),
        (i16, write_i16, 2, write_i16),
        (i32, write_i32, 4, write_i32),
        (i64, write_i64, 8, write_i64),
        (i128, write_i128, 16, write_i128)
    );
    define_write!(
        #[doc = write_doc!(f32, write_f32, float)]
        (f32, write_f32, 4, write_f32)
    );
    define_write!(
        #[doc = write_doc!(f32, write_f32, float)]
        (f64, write_f64, 8, write_f64)
    );
}
impl<'a, T: DigestWriter> DigestWriter for &'a mut T {
    deref_and_call_inner!();
}
#[cfg(feature = "alloc")]
mod has_alloc {
    use crate::DigestWriter;
    use alloc::boxed::Box;
    use alloc::vec::Vec;

    impl DigestWriter for Vec<u8> {
        fn write(&mut self, data: &[u8]) {
            self.extend_from_slice(data);
        }
    }
    impl<T: DigestWriter> DigestWriter for Box<T> {
        deref_and_call_inner!();
    }
}

#[cfg(feature = "bytes")]
impl DigestWriter for bytes::BytesMut {
    fn write(&mut self, data: &[u8]) {
        self.extend_from_slice(data);
    }
}