splashboard 1.4.0

A customizable terminal splash screen with plugin-based data sources
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
77
78
79
80
81

use std::collections::HashMap;

use ratatui::{Terminal, backend::TestBackend, buffer::Buffer};

use crate::config::General;
use crate::layout::{self, Layout, WidgetId};
use crate::payload::Payload;
use crate::render::{Registry, RenderSpec, render_payload};
use crate::theme::Theme;

/// Render a single payload through the default renderer for its shape.
pub fn render_to_buffer(payload: &Payload, width: u16, height: u16) -> Buffer {
    render_to_buffer_with_spec(payload, None, &Registry::with_builtins(), width, height)
}

/// Render a single payload through a specific renderer spec — used when a test needs to
/// exercise a non-default renderer (e.g. `ascii_art` for a `Text` payload).
pub fn render_to_buffer_with_spec(
    payload: &Payload,
    spec: Option<&RenderSpec>,
    registry: &Registry,
    width: u16,
    height: u16,
) -> Buffer {
    let backend = TestBackend::new(width, height);
    let mut terminal = Terminal::new(backend).unwrap();
    let theme = Theme::default();
    let general = General::default();
    terminal
        .draw(|f| render_payload(f, f.area(), payload, spec, registry, &theme, &general))
        .unwrap();
    terminal.backend().buffer().clone()
}

/// Render a whole layout with its widget payloads. Render specs default per-shape; callers who
/// need custom renderers should use [`render_to_buffer_with_layout_and_specs`].
pub fn render_to_buffer_with(
    root: &Layout,
    widgets: &HashMap<WidgetId, Payload>,
    width: u16,
    height: u16,
) -> Buffer {
    render_to_buffer_with_layout_and_specs(root, widgets, &HashMap::new(), width, height)
}

pub fn render_to_buffer_with_layout_and_specs(
    root: &Layout,
    widgets: &HashMap<WidgetId, Payload>,
    specs: &HashMap<WidgetId, RenderSpec>,
    width: u16,
    height: u16,
) -> Buffer {
    let registry = Registry::with_builtins();
    let theme = Theme::default();
    let general = General::default();
    let loading = HashMap::new();
    let backend = TestBackend::new(width, height);
    let mut terminal = Terminal::new(backend).unwrap();
    terminal
        .draw(|f| {
            layout::draw(
                f,
                f.area(),
                root,
                widgets,
                specs,
                &registry,
                &theme,
                &general,
                &loading,
            )
        })
        .unwrap();
    terminal.backend().buffer().clone()
}

pub fn line_text(buf: &Buffer, y: u16) -> String {
    (0..buf.area.width)
        .map(|x| buf.cell((x, y)).unwrap().symbol().to_string())
        .collect()
}