tuit 0.2.1

A no_std, no_alloc TUI library
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

use crate::prelude::{Terminal, TerminalConst, Widget};
use crate::style::{Colour, Style};
use crate::terminal::{Rectangle, UpdateInfo, UpdateResult};
use crate::widgets::BoundingBox;

/// A widget that will clear the entire terminal and replace it with a blank cell containing
/// the specified style.
pub struct Sweeper {
    /// The style to use for the blank cells that clear the terminal.
    pub style: Style,
}

impl Sweeper {
    /// Creates a new [`Sweeper`] with the specified [`Style`]
    #[must_use]
    pub const fn new(style: Style) -> Self {
        Self { style }
    }

    /// Creates a new [`Sweeper`] with the specified [`Colour`] and a blank style
    #[must_use]
    pub const fn of_colour(colour: Colour) -> Self {
        Self {
            style: Style::new().bg(colour)
        }
    }
}

impl Widget for Sweeper {
    fn update(
        &mut self,
        _update_info: UpdateInfo,
        _terminal: impl TerminalConst,
    ) -> crate::Result<UpdateResult> {
        Ok(UpdateResult::NoEvent)
    }

    fn draw(
        &self,
        _update_info: UpdateInfo,
        mut terminal: impl Terminal,
    ) -> crate::Result<UpdateResult> {
        for character in terminal.cells_mut() {
            character.style = self.style;
            character.character = ' ';
        }

        Ok(UpdateResult::NoEvent)
    }
}

impl BoundingBox for Sweeper {
    fn bounding_box(&self, rect: Rectangle) -> crate::Result<Rectangle> {
        Ok(rect)
    }

    fn completely_covers(&self, _rectangle: Rectangle) -> bool {
        true
    }
}