mirui 0.21.1

A lightweight, no_std ECS-driven UI framework for embedded, desktop, and WebAssembly
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

use crate::app::{App, RendererFactory};
use crate::cache::{CacheRegistry, CacheStatsSnapshot};
use crate::ecs::World;
use crate::plugin::Plugin;
use crate::surface::Surface;

/// Calls a sink with the latest [`CacheRegistry`] snapshot every N
/// frames so user code can observe live backend cache stats (entries,
/// hit, miss, max_size) without poking the backend directly.
///
/// **Inserts**
/// - hooks: `post_render`
pub struct CacheReportPlugin {
    frames_per_report: u32,
    frame_count: u32,
    on_report: fn(report: CacheReport<'_>),
}

/// Snapshot handed to the [`CacheReportPlugin`] sink each window.
pub struct CacheReport<'a> {
    pub frames: u32,
    pub snapshots: &'a [CacheStatsSnapshot],
}

impl CacheReportPlugin {
    pub fn new(frames_per_report: u32) -> Self {
        Self {
            frames_per_report,
            frame_count: 0,
            on_report: default_report,
        }
    }

    pub fn with_sink(mut self, sink: fn(CacheReport<'_>)) -> Self {
        self.on_report = sink;
        self
    }
}

impl Default for CacheReportPlugin {
    fn default() -> Self {
        Self::new(60)
    }
}

impl<B, F> Plugin<B, F> for CacheReportPlugin
where
    B: Surface,
    F: RendererFactory<B>,
{
    fn build(&mut self, _app: &mut App<B, F>) {}

    fn post_render(&mut self, world: &mut World, _render_nanos: u64) {
        self.frame_count += 1;
        if self.frame_count < self.frames_per_report {
            return;
        }
        let Some(reg) = world.resource::<CacheRegistry>() else {
            self.frame_count = 0;
            return;
        };
        (self.on_report)(CacheReport {
            frames: self.frame_count,
            snapshots: reg.snapshots(),
        });
        self.frame_count = 0;
    }
}

#[cfg(feature = "std")]
fn default_report(report: CacheReport<'_>) {
    if report.snapshots.is_empty() {
        return;
    }
    eprintln!("[cache] after {} frames", report.frames);
    for snap in report.snapshots {
        let total = snap.stats.hit_count + snap.stats.miss_count;
        let hit_rate = if total == 0 {
            0.0
        } else {
            snap.stats.hit_count as f64 * 100.0 / total as f64
        };
        eprintln!(
            "  {} entries={} hit={} miss={} ({:.1}%) max={:?}",
            snap.name,
            snap.len,
            snap.stats.hit_count,
            snap.stats.miss_count,
            hit_rate,
            snap.max_size,
        );
    }
}

#[cfg(not(feature = "std"))]
fn default_report(_report: CacheReport<'_>) {}