ascii_renderer/
char_buffer.rs

1///The buffer used by the runner and mutated by the logic struct. Just a wrapper around a 2D char vector.
2/// # Example
3/// ```
4/// let mut buf = CharBuffer::new(3, 3);
5/// buf.set_char(0, 0, 'n').unwrap();
6/// buf.set_char(2, 1, 'x').unwrap();
7/// buf.set_char(2, 2, 'z').unwrap();
8/// assert_eq!(&buf.to_string(), "n     \n    x \n    z \n");
9///```
10#[derive(Debug, Clone, PartialEq, PartialOrd)]
11pub struct CharBuffer {
12    pub data: Vec<Vec<char>>,
13    pub dimensions: (usize, usize),
14}
15
16#[derive(Debug)]
17pub enum CharBufferError {
18    RowOutOfRange { row: usize },
19    ItemOutOfRange { index: usize },
20}
21
22impl CharBuffer {
23    pub fn new(width: usize, height: usize) -> Self {
24        CharBuffer {
25            data: vec![vec![' '; width]; height],
26            dimensions: (width, height),
27        }
28    }
29    pub fn get_char(&self, x: usize, y: usize) -> Option<char> {
30        self.data.get(y)?.get(x).map(|x| *x)
31    }
32    pub fn set_char(&mut self, x: usize, y: usize, value: char) -> Result<(), CharBufferError> {
33        let row = self.data.get_mut(y);
34        if row.is_none() {
35            return Err(CharBufferError::RowOutOfRange { row: y });
36        }
37
38        let item = row.unwrap().get_mut(x);
39        if item.is_none() {
40            return Err(CharBufferError::ItemOutOfRange { index: x });
41        }
42
43        *item.unwrap() = value;
44
45        Ok(())
46    }
47    pub fn fill(&mut self, char: char) {
48        //! Filles the char buffer with the given char
49        for row in self.data.iter_mut() {
50            for item in row.iter_mut() {
51                *item = char;
52            }
53        }
54    }
55}
56
57impl std::fmt::Display for CharBuffer {
58    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
59        write!(
60            f,
61            "{}",
62            self.data
63                .iter()
64                .map(|x| [
65                    x.iter().map(|x| [x, &' ']).flatten().collect::<String>(),
66                    "\n".to_owned()
67                ])
68                .flatten()
69                .collect::<String>()
70        )
71    }
72}
73
74#[cfg(test)]
75mod tests {
76    use super::*;
77
78    #[test]
79    fn char_retreival() {
80        let mut buf = CharBuffer::new(3, 3);
81        buf.set_char(2, 2, 'x').unwrap();
82        assert_eq!(buf.get_char(2, 2).unwrap(), 'x');
83    }
84
85    #[test]
86    #[should_panic]
87    fn char_setter_bounds_check() {
88        let mut buf = CharBuffer::new(2, 2);
89        buf.set_char(2, 2, 'x').unwrap();
90    }
91
92    #[test]
93    #[should_panic]
94    fn char_getter_bounds_check() {
95        let buf = CharBuffer::new(2, 2);
96        buf.get_char(2, 2).unwrap();
97    }
98
99    #[test]
100    fn char_buf_to_string() {
101        let mut buf = CharBuffer::new(3, 3);
102        buf.set_char(0, 0, 'n').unwrap();
103        buf.set_char(2, 1, 'x').unwrap();
104        buf.set_char(2, 2, 'z').unwrap();
105        assert_eq!(&buf.to_string(), "n     \n    x \n    z \n");
106    }
107}