prototty 0.15.0

Utilities for easily and efficiently rendering to a terminal.
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

use coord::{Coord, Size};
use rgb24::Rgb24;

/// A cell that a view can write to
pub trait ViewCell {
    fn set_character(&mut self, character: char);
    fn set_bold(&mut self, bold: bool);
    fn set_underline(&mut self, underline: bool);
    fn set_foreground_colour(&mut self, colour: Rgb24);
    fn set_background_colour(&mut self, colour: Rgb24);
}

/// A grid of cells
pub trait ViewGrid {
    type Cell: ViewCell;
    fn get_mut(&mut self, coord: Coord, depth: i32) -> Option<&mut Self::Cell>;
}

/// Defines a method for rendering a `T` to the terminal.
pub trait View<T> {
     /// Update the cells in `grid` to describe how a type should be rendered.
    fn view<G: ViewGrid>(&mut self, data: &T, offset: Coord, depth: i32, grid: &mut G);
}

/// Report the size of a `T` when rendered.
pub trait ViewSize<T> {
     /// Returns the size in cells of the rectangle containing a ui element.
     /// This allows for the implementation of decorator ui components that
     /// render a border around some inner element.
    fn size(&mut self, data: &T) -> Size;
}

/// Trait to implement for renderers that take data and a view that knows how
/// to render the data to a grid, and actually draws the result.
pub trait Renderer {
    type Error: ::std::fmt::Debug;

    fn render_at<V: View<T>, T>(&mut self, view: &mut V, data: &T, offset: Coord, depth: i32) -> Result<(), Self::Error>;
    fn render<V: View<T>, T>(&mut self, view: &mut V, data: &T) -> Result<(), Self::Error> {
        self.render_at(view, data, Coord::new(0, 0), 0)
    }
}