osui 0.2.0

A TUI library for advanced uis
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! # Benchmark Module
//!
//! Provides performance benchmarking capabilities for rendering engines.

use std::{io::stdout, sync::Arc, time::Instant};

use crossterm::{cursor::MoveTo, execute, terminal::Clear};

use crate::component::{context::Context, ComponentImpl};
use crate::{render::Area, DrawContext, View};

use super::Engine;

/// Results of a benchmark run
#[derive(Debug, Clone)]
pub struct BenchmarkResult {
    /// Average render time in microseconds
    pub average: u128,
    /// Minimum render time in microseconds
    pub min: u128,
    /// Maximum render time in microseconds
    pub max: u128,
    /// Total time spent rendering in microseconds
    pub total_render: u128,
    /// Total benchmark time including setup in microseconds
    pub total: u128,
}

/// Wraps an engine to benchmark its rendering performance
pub struct Benchmark<T: Engine>(T);

impl<T: Engine> Benchmark<T> {
    /// Creates a new benchmark wrapper around the given engine
    pub fn new(engine: T) -> Self {
        Self(engine)
    }
}

impl<T: Engine> Engine<BenchmarkResult> for Benchmark<T> {
    fn run<F: ComponentImpl + 'static>(&self, component: F) -> crate::Result<BenchmarkResult> {
        let mut times: Vec<u128> = Vec::new();
        let cx = self.init(component);

        let start = Instant::now();

        // Run 40 render cycles and measure each
        for _ in 0..40 {
            let start = Instant::now();
            self.render(&cx);
            let end = Instant::now();
            times.push(end.duration_since(start).as_micros());
        }

        let end = Instant::now();

        execute!(stdout(), Clear(crossterm::terminal::ClearType::Purge)).unwrap();
        execute!(stdout(), Clear(crossterm::terminal::ClearType::All)).unwrap();
        execute!(stdout(), MoveTo(0, 0)).unwrap();

        Ok(BenchmarkResult {
            min: *times.iter().min().unwrap_or(&0),
            max: *times.iter().max().unwrap_or(&0),
            total: end.duration_since(start).as_micros(),
            total_render: times.iter().sum::<u128>(),
            average: if times.len() > 0 {
                times.iter().sum::<u128>() / (times.len() as u128)
            } else {
                0
            },
        })
    }

    fn init<F: ComponentImpl + 'static>(&self, component: F) -> Arc<Context> {
        self.0.init(component)
    }

    fn draw_context(&self, ctx: &DrawContext) {
        self.0.draw_context(ctx)
    }

    fn render(&self, cx: &Arc<Context>) {
        self.0.render(cx)
    }

    fn render_view(&self, area: &Area, view: &View) -> DrawContext {
        self.0.render_view(area, view)
    }

    fn render_delay(&self) {
        self.0.render_delay();
    }

    fn executor(&self) -> Arc<dyn super::CommandExecutor> {
        self.0.executor()
    }
}

impl std::fmt::Display for BenchmarkResult {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "- Average: {} µs\n\
             - Min: {} µs\n\
             - Max: {} µs\n\
             - Total Render: {} µs\n\
             - Total: {} µs",
            self.average, self.min, self.max, self.total_render, self.total
        )
    }
}