mirui 0.22.0

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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use super::algorithm::Algorithm;
use super::budget::MaxSize;
use super::core::Cache;
use super::lookup::Lookup;
use super::stats::CacheStats;

/// Type-erased read-only view over a single cache instance. Consumers
/// (registry, dump tools, plugins) iterate `&dyn CacheInspect` without
/// caring about the concrete `K / V / A / L` parameters.
pub trait CacheInspect: 'static {
    fn cache_name(&self) -> &'static str;
    fn cache_stats(&self) -> &CacheStats;
    fn cache_len(&self) -> usize;
    fn cache_max_size(&self) -> &MaxSize;
}

impl<K, V, A, L> CacheInspect for Cache<K, V, A, L>
where
    K: 'static,
    V: 'static,
    A: Algorithm + 'static,
    L: Lookup<K> + 'static,
{
    fn cache_name(&self) -> &'static str {
        self.name().unwrap_or("<unnamed>")
    }
    fn cache_stats(&self) -> &CacheStats {
        self.stats()
    }
    fn cache_len(&self) -> usize {
        self.len()
    }
    fn cache_max_size(&self) -> &MaxSize {
        self.max_size()
    }
}

/// One entry point over multiple caches owned by the same container
/// (e.g. a backend with label + shape caches). Consumers iterate once
/// instead of poking each cache field by name. Default returns an
/// empty iterator so backends without caches need no override.
pub trait InspectCaches {
    fn inspect_caches(&self) -> impl Iterator<Item = (&'static str, &dyn CacheInspect)> + '_ {
        core::iter::empty()
    }
}

/// Owned snapshot of a single cache's observable state. `World`
/// resource carries a `Vec` of these so plugins / systems can read
/// stats without holding a live borrow into the backend.
#[derive(Debug, Clone, Copy)]
pub struct CacheStatsSnapshot {
    pub name: &'static str,
    pub stats: CacheStats,
    pub len: usize,
    pub max_size: MaxSize,
}

impl CacheStatsSnapshot {
    pub fn capture(cache: &dyn CacheInspect) -> Self {
        Self {
            name: cache.cache_name(),
            stats: *cache.cache_stats(),
            len: cache.cache_len(),
            max_size: *cache.cache_max_size(),
        }
    }
}

/// World resource: latest cache snapshots, refreshed by `App::run`
/// each frame between `FrameTimings` publish and `post_render`.
#[derive(Debug, Default)]
pub struct CacheRegistry {
    snapshots: alloc::vec::Vec<CacheStatsSnapshot>,
}

impl CacheRegistry {
    pub(crate) fn from_snapshots(snapshots: alloc::vec::Vec<CacheStatsSnapshot>) -> Self {
        Self { snapshots }
    }

    pub fn snapshots(&self) -> &[CacheStatsSnapshot] {
        &self.snapshots
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cache::{HashLookup, Lru, MaxSize as M};
    use alloc::vec::Vec;

    #[test]
    fn cache_inspect_reports_name_stats_len_max() {
        let mut cache: Cache<u32, u32, Lru, HashLookup<u32>> = Cache::builder()
            .max_size(M::Count(8))
            .name("test_cache")
            .build();
        cache.entry(1).or_insert_with(|| 10);

        let view: &dyn CacheInspect = &cache;
        assert_eq!(view.cache_name(), "test_cache");
        assert_eq!(view.cache_len(), 1);
        assert_eq!(*view.cache_max_size(), M::Count(8));
        assert_eq!(view.cache_stats().insert_count, 1);
    }

    #[test]
    fn unnamed_cache_falls_back() {
        let cache: Cache<u32, u32, Lru, HashLookup<u32>> =
            Cache::builder().max_size(M::Count(2)).build();
        let view: &dyn CacheInspect = &cache;
        assert_eq!(view.cache_name(), "<unnamed>");
    }

    #[test]
    fn inspect_caches_walks_a_collection() {
        struct Two<A, B>(A, B);
        impl<A: CacheInspect, B: CacheInspect> InspectCaches for Two<A, B> {
            fn inspect_caches(
                &self,
            ) -> impl Iterator<Item = (&'static str, &dyn CacheInspect)> + '_ {
                [("first", &self.0 as &dyn CacheInspect), ("second", &self.1)].into_iter()
            }
        }

        let c1: Cache<u32, u32, Lru, HashLookup<u32>> =
            Cache::builder().max_size(M::Count(2)).name("c1").build();
        let c2: Cache<u32, u32, Lru, HashLookup<u32>> =
            Cache::builder().max_size(M::Count(4)).name("c2").build();
        let two = Two(c1, c2);

        let names: Vec<_> = two.inspect_caches().map(|(n, _)| n).collect();
        assert_eq!(names, ["first", "second"]);
    }
}