viuer 0.11.0

Display images in the terminal
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 console::{Key, Term};

/// Trait to allow reading keys from multiple inputs like [`Term`] (via [`Term::read_key`]) or a custom Testing utility.
pub trait ReadKey {
    fn read_key(&self) -> std::io::Result<Key>;
}

impl ReadKey for Term {
    fn read_key(&self) -> std::io::Result<Key> {
        self.read_key()
    }
}

#[cfg(test)]
pub mod test_utils {
    use std::{cell::RefCell, io};

    use console::Key;

    use super::ReadKey;

    /// Test Utility to replay key sequences like otherwise gotten from a normal console via [`console::Term`].
    ///
    /// Will returns a error if the sequence has reached the end, but a new one is requested.
    #[derive(Debug, Clone)]
    pub struct TestKeys<'a> {
        data: &'a [Key],
        /// The trait is &self as it is build around current Term, which only has Term::ready_key(&self) signature.
        /// Hence, cannot modify inner state unless we use inner mutability here, like RefCell.
        next_idx: RefCell<usize>,
    }

    impl<'a> TestKeys<'a> {
        pub fn new(data: &'a [Key]) -> Self {
            Self {
                data,
                next_idx: RefCell::new(0),
            }
        }

        /// Test if all the data in this instance has been replayed exactly.
        pub fn reached_end(&self) -> bool {
            *self.next_idx.borrow() == self.data.len()
        }
    }

    impl ReadKey for TestKeys<'_> {
        fn read_key(&self) -> io::Result<Key> {
            let idx = *self.next_idx.borrow();

            if idx >= self.data.len() {
                return Err(io::Error::new(
                    io::ErrorKind::UnexpectedEof,
                    "Reached the end of the data",
                ));
            }

            *self.next_idx.borrow_mut() += 1;
            Ok(self.data[idx].clone())
        }
    }
}