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

//! Structures and traits for representing byte ranges in memory

#[cfg(feature = "alloc")]
use alloc::vec::Vec;
use core::{fmt::Debug, ops::Range};

use crate::error::Error;

mod array;
pub use self::array::ArrayKey;

mod hash;
pub use self::hash::HashBuffer;

#[cfg(feature = "alloc")]
mod secret;
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::secret::SecretBytes;

mod string;
pub use self::string::HexRepr;

mod writer;
pub use self::writer::Writer;

/// Support for writing to a byte buffer
pub trait WriteBuffer: Debug {
    /// Append a slice to the buffer
    fn buffer_write(&mut self, data: &[u8]) -> Result<(), Error>;
}

/// Support for writing to, accessing, and resizing a byte buffer
pub trait ResizeBuffer: WriteBuffer + AsRef<[u8]> + AsMut<[u8]> {
    /// Insert a slice at the given position in the buffer
    fn buffer_insert(&mut self, pos: usize, data: &[u8]) -> Result<(), Error>;

    /// Remove an exclusive range from the buffer
    fn buffer_remove(&mut self, range: Range<usize>) -> Result<(), Error>;

    /// Resize the buffer, truncating or padding it with zeroes
    fn buffer_resize(&mut self, len: usize) -> Result<(), Error>;

    /// Extend the buffer with `len` bytes of zeroes and return
    /// a mutable reference to the slice
    fn buffer_extend(&mut self, len: usize) -> Result<&mut [u8], Error> {
        let pos = self.as_ref().len();
        let end = pos + len;
        self.buffer_resize(end)?;
        Ok(&mut self.as_mut()[pos..end])
    }
}

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
impl WriteBuffer for Vec<u8> {
    fn buffer_write(&mut self, data: &[u8]) -> Result<(), Error> {
        self.extend_from_slice(data);
        Ok(())
    }
}

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
impl ResizeBuffer for Vec<u8> {
    fn buffer_insert(&mut self, pos: usize, data: &[u8]) -> Result<(), Error> {
        self.splice(pos..pos, data.into_iter().cloned());
        Ok(())
    }

    fn buffer_remove(&mut self, range: Range<usize>) -> Result<(), Error> {
        self.drain(range);
        Ok(())
    }

    fn buffer_resize(&mut self, len: usize) -> Result<(), Error> {
        self.resize(len, 0u8);
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    pub(crate) fn test_write_buffer<B: WriteBuffer + AsRef<[u8]>>(mut w: B) {
        w.buffer_write(b"he").unwrap();
        w.buffer_write(b"y").unwrap();
        assert_eq!(&w.as_ref()[..], b"hey");
    }

    pub(crate) fn test_resize_buffer<B: ResizeBuffer>(mut w: B) {
        w.buffer_write(b"hello").unwrap();
        w.buffer_insert(1, b"world").unwrap();
        assert_eq!(&w.as_ref()[..], b"hworldello");
        w.buffer_resize(12).unwrap();
        assert_eq!(&w.as_ref()[..], b"hworldello\0\0");
        w.buffer_resize(6).unwrap();
        assert_eq!(&w.as_ref()[..], b"hworld");
        w.buffer_insert(1, b"ello").unwrap();
        assert_eq!(&w.as_ref()[..], b"helloworld");
    }

    #[test]
    fn write_buffer_vec() {
        test_write_buffer(Vec::new());
    }

    #[test]
    fn resize_buffer_vec() {
        test_resize_buffer(Vec::new());
    }
}