tuirealm 4.0.0

A tui-rs framework to build tui interfaces, inspired by React and Elm.
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

//! Test backend provides the [`TestBackend`](ratatui::backend::TestBackend) which can be used for
//! integration tests: [`TestBackend`].

use ratatui::Terminal;
use ratatui::backend::TestBackend;
use ratatui::layout::Size;

use crate::ratatui::TerminalOptions;
use crate::terminal::{TerminalAdapter, TerminalError, TerminalResult};

/// A [`TerminalAdapter`] implementing the ratatui [`TestBackend`].
///
/// This backend is useful for doing integration tests.
pub struct TestTerminalAdapter {
    terminal: Terminal<TestBackend>,
}

impl TestTerminalAdapter {
    /// Create a new [`TestTerminalAdapter`] instance with default ratatui Terminal options and the provided
    /// height and width.
    pub fn new(size: Size) -> TerminalResult<Self> {
        Self::new_with_options(size, TerminalOptions::default())
    }

    /// Create a new [`TestTerminalAdapter`] instance with custom ratatui Terminal options, and the provided
    /// sizes.
    pub fn new_with_options(size: Size, options: TerminalOptions) -> TerminalResult<Self> {
        let backend = TestBackend::new(size.width, size.height);
        let terminal = Terminal::with_options(backend, options)
            .map_err(|_| TerminalError::Other("Failed creating terminal"))?;

        Ok(Self { terminal })
    }
}

impl TerminalAdapter for TestTerminalAdapter {
    type Backend = TestBackend;

    /// UNSUPPORTED in test backend
    fn enable_raw_mode(&mut self) -> TerminalResult<()> {
        Err(TerminalError::Unsupported)
    }

    /// UNSUPPORTED in test backend
    fn disable_raw_mode(&mut self) -> TerminalResult<()> {
        Err(TerminalError::Unsupported)
    }

    /// UNSUPPORTED in test backend
    fn enter_alternate_screen(&mut self) -> TerminalResult<()> {
        Err(TerminalError::Unsupported)
    }

    /// UNSUPPORTED in test backend
    fn leave_alternate_screen(&mut self) -> TerminalResult<()> {
        Err(TerminalError::Unsupported)
    }

    /// UNSUPPORTED in test backend
    fn enable_mouse_capture(&mut self) -> TerminalResult<()> {
        Err(TerminalError::Unsupported)
    }

    /// UNSUPPORTED in test backend
    fn disable_mouse_capture(&mut self) -> TerminalResult<()> {
        Err(TerminalError::Unsupported)
    }

    fn raw_mut(&mut self) -> &mut Terminal<ratatui::backend::TestBackend> {
        &mut self.terminal
    }

    fn raw(&self) -> &Terminal<ratatui::backend::TestBackend> {
        &self.terminal
    }
}