digest/core_api/
xof_reader.rs

1use super::{AlgorithmName, XofReaderCore};
2use crate::XofReader;
3use block_buffer::ReadBuffer;
4use core::fmt;
5
6/// Wrapper around [`XofReaderCore`] implementations.
7///
8/// It handles data buffering and implements the mid-level traits.
9#[derive(Clone, Default)]
10pub struct XofReaderCoreWrapper<T>
11where
12    T: XofReaderCore,
13{
14    pub(super) core: T,
15    pub(super) buffer: ReadBuffer<T::BlockSize>,
16}
17
18impl<T> fmt::Debug for XofReaderCoreWrapper<T>
19where
20    T: XofReaderCore + AlgorithmName,
21{
22    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
23        T::write_alg_name(f)?;
24        f.write_str(" { .. }")
25    }
26}
27
28impl<T> XofReader for XofReaderCoreWrapper<T>
29where
30    T: XofReaderCore,
31{
32    #[inline]
33    fn read(&mut self, buffer: &mut [u8]) {
34        let Self { core, buffer: buf } = self;
35        buf.read(buffer, |block| *block = core.read_block());
36    }
37}
38
39#[cfg(feature = "std")]
40impl<T> std::io::Read for XofReaderCoreWrapper<T>
41where
42    T: XofReaderCore,
43{
44    #[inline]
45    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
46        XofReader::read(self, buf);
47        Ok(buf.len())
48    }
49}
50
51impl<T: XofReaderCore> Drop for XofReaderCoreWrapper<T> {
52    #[inline]
53    fn drop(&mut self) {
54        #[cfg(feature = "zeroize")]
55        {
56            use zeroize::Zeroize;
57            self.buffer.zeroize();
58        }
59    }
60}
61
62#[cfg(feature = "zeroize")]
63impl<T: XofReaderCore + zeroize::ZeroizeOnDrop> zeroize::ZeroizeOnDrop for XofReaderCoreWrapper<T> {}