data-view 5.1.0

This library provides a data view for reading and writing data in a byte array.
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

use super::*;

/// A data view for reading and writing data in byte array.
///
/// # Examples
///
/// ```
/// use data_view::View;
///
/// let mut buf = [0; 16];
///
/// buf.write_at(1, 42_u16);
/// assert_eq!(buf.read_at::<u16>(1).unwrap(), 42);
/// ```
pub trait View {
    /// Reads a value of type `E: Endian` from view.
    ///
    /// # Examples
    ///
    /// ```
    /// use data_view::View;
    ///
    /// let buf = [42];
    ///
    /// assert_eq!(buf.read_at::<u8>(0), Some(42));
    /// assert_eq!(buf.read_at::<u16>(1), None);
    /// ```
    fn read_at<E: Endian>(&self, offset: usize) -> Option<E>;

    /// Writes a value of type `E: Endian` to data view.
    ///
    /// # Examples
    ///
    /// ```
    /// use data_view::View;
    ///
    /// let mut buf = [0];
    ///
    /// assert_eq!(buf.write_at(0, 42_u8), Ok(()));
    /// assert_eq!(buf.write_at(1, 123_u16), Err(()));
    /// ```
    fn write_at<E: Endian>(&mut self, offset: usize, num: E) -> Result<(), ()>;
}

impl View for [u8] {
    #[inline]
    fn read_at<E: Endian>(&self, offset: usize) -> Option<E> {
        if offset + size_of::<E>() > self.len() {
            return None;
        }
        Some(unsafe { E::__read_at__(self.as_ptr().add(offset)) })
    }

    #[inline]
    fn write_at<E: Endian>(&mut self, offset: usize, num: E) -> Result<(), ()> {
        if offset + size_of::<E>() > self.len() {
            return Err(());
        }
        unsafe { E::__write_at__(num, self.as_mut_ptr().add(offset)) };
        Ok(())
    }
}