grixy 0.3.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
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

use crate::{
    core::{Pos, Size},
    grid::GridBase,
};

/// A bounded grid type that provides methods to access its dimensions.
///
/// ## Safety
///
/// If the dimensions provide are not accurate, it may lead to _[undefined behavior][]_.
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe trait BoundedGrid: GridBase {
    /// Returns the width of the grid, in columns.
    fn width(&self) -> usize;

    /// Returns the height of the grid, in rows.
    fn height(&self) -> usize;

    /// Returns the size of the grid.
    fn size(&self) -> Size {
        Size {
            width: self.width(),
            height: self.height(),
        }
    }

    /// Returns whether the given coordinates are valid for this grid.
    fn contains(&self, x: usize, y: usize) -> bool {
        x < self.width() && y < self.height()
    }

    /// Returns whether the given position is valid for this grid.
    fn contains_pos(&self, pos: Pos) -> bool {
        self.contains(pos.x, pos.y)
    }
}

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

    struct TestGrid {
        width: usize,
        height: usize,
    }

    impl GridBase for TestGrid {
        type Element = ();
    }

    unsafe impl BoundedGrid for TestGrid {
        fn width(&self) -> usize {
            self.width
        }

        fn height(&self) -> usize {
            self.height
        }
    }

    #[test]
    fn size() {
        let grid = TestGrid {
            width: 10,
            height: 5,
        };
        assert_eq!(
            grid.size(),
            Size {
                width: 10,
                height: 5
            }
        );
    }

    #[test]
    fn contains_true() {
        let grid = TestGrid {
            width: 10,
            height: 5,
        };
        assert!(grid.contains(5, 3));
        assert!(grid.contains_pos(Pos::new(5, 3)));
    }

    #[test]
    fn contains_false_x() {
        let grid = TestGrid {
            width: 10,
            height: 5,
        };
        assert!(!grid.contains(10, 3));
        assert!(!grid.contains_pos(Pos::new(10, 3)));
    }

    #[test]
    fn contains_false_y() {
        let grid = TestGrid {
            width: 10,
            height: 5,
        };
        assert!(!grid.contains(5, 5));
        assert!(!grid.contains_pos(Pos::new(5, 5)));
    }
}