grixy 0.2.0

2-dimensional grids
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

use crate::buf::GridBuf;

/// A 2-dimensional grid implemented by a slice buffer.
///
/// This is a convenience type for using slices as the underlying buffer.
///
/// ## Layout
///
/// The grid is stored in a linear buffer, with elements accessed in an order defined by [`Layout`][].
///
/// [`Layout`]: `crate::core::Layout`
pub type SliceGrid<'a, T, L> = GridBuf<T, &'a [T], L>;

/// A 2-dimensional grid implemented by a mutable slice buffer.
///
/// This is a convenience type for using mutable slices as the underlying buffer.
///
/// ## Layout
///
/// The grid is stored in a linear buffer, with elements accessed in an order defined by [`Layout`][].
///
/// [`Layout`]: `crate::core::Layout`
pub type SliceMutGrid<'a, T, L> = GridBuf<T, &'a mut [T], L>;

#[cfg(test)]
mod tests {
    use crate::core::Pos;

    use super::*;

    #[test]
    fn impl_slice() {
        let data: &[u8] = &[1, 2, 3, 4, 5, 6];
        let grid = SliceGrid::with_buffer_row_major(data, 2, 3).unwrap();

        assert_eq!(grid.get(Pos::new(0, 0)), Some(&1));
        assert_eq!(grid.get(Pos::new(1, 2)), Some(&6));
    }

    #[test]
    fn impl_slice_mut() {
        let mut data: [u8; 6] = [1, 2, 3, 4, 5, 6];
        let mut grid = SliceMutGrid::with_buffer_row_major(&mut data, 2, 3).unwrap();

        assert_eq!(grid.get(Pos::new(0, 0)), Some(&1));
        assert_eq!(grid.get(Pos::new(1, 2)), Some(&6));

        *grid.get_mut(Pos::new(0, 0)).unwrap() = 10;
        assert_eq!(grid.get(Pos::new(0, 0)), Some(&10));
    }
}