lgui-core 0.2.0

Platform-neutral runtime and UI primitives for LGUI
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

//! Application-scoped resource accounting, cache policy, pressure, and persistence.

mod governor;
mod lru;
mod options;
mod policy;
mod registry;
mod stats;

#[cfg(feature = "persistent-cache")]
mod persistent;

pub use governor::{MemoryGovernor, MemoryReservation, MemoryTaskReservation};
#[doc(hidden)]
pub use lru::LruCache;
pub use options::{MemoryBudget, MemoryDomainBudgets, MemoryEventPolicy, MemoryOptions};
pub use policy::{
    CacheDomain, CacheKey, CachePriority, CacheScope, ImageCachePolicy, MemoryAction, MemoryEvent,
    ResourceClass, RetentionClass, TrimReason,
};
pub use registry::{
    CacheAdapter, CacheRegistration, DomainInstanceId, DomainRegistration, TrimRequest, TrimResult,
};
#[doc(hidden)]
pub use stats::CacheTelemetry;
pub use stats::{CacheUsage, DomainSnapshot, MemorySnapshot, TrimSnapshot};

#[cfg(feature = "persistent-cache")]
pub use persistent::{
    CacheStoreError, FileCacheStore, PersistentCacheKey, PersistentCacheStats,
    PersistentCacheStore, PersistentEntry,
};

#[path = "memory_test.rs"]
#[cfg(test)]
mod tests;

#[cfg(any(test, feature = "test-support"))]
#[doc(hidden)]
pub const fn test_memory_options() -> MemoryOptions {
    const MIB: usize = 1024 * 1024;
    MemoryOptions::new(
        "lgui-tests",
        MemoryBudget::new(
            64 * MIB,
            96 * MIB,
            64 * MIB,
            64 * MIB as u64,
            8 * MIB,
            16 * MIB,
            4,
        ),
        MemoryDomainBudgets {
            encoded_image_bytes: 16 * MIB,
            decoded_image_bytes: 16 * MIB,
            svg_bytes: 4 * MIB,
            blur_bytes: 4 * MIB,
            text_bytes: 8 * MIB,
            static_layer_bytes: 8 * MIB,
            scroll_raster_bytes: 4 * MIB,
            gdi_bytes: 16 * MIB,
            d2d_bytes: 16 * MIB,
            skia_bytes: 16 * MIB,
            component_output_bytes: 4 * MIB,
            host_scene_bytes: 4 * MIB,
            diagnostics_bytes: 2 * MIB,
        },
        MemoryEventPolicy::ignore_all(),
        ImageCachePolicy::Session,
        true,
    )
}

#[cfg(all(feature = "persistent-cache", any(test, feature = "test-support")))]
#[doc(hidden)]
pub fn test_memory_governor_with_store(
    options: MemoryOptions,
    store: std::sync::Arc<dyn PersistentCacheStore>,
) -> MemoryGovernor {
    MemoryGovernor::with_store(options, Some(store))
}