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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
use std::{
collections::{
HashMap,
HashSet,
},
time::Duration,
};
use bytes::Bytes;
use dioxus_core::prelude::{
current_scope_id,
spawn_forever,
ScopeId,
Task,
};
use dioxus_hooks::{
use_context,
use_context_provider,
};
use dioxus_signals::{
Readable,
Signal,
Writable,
};
use tokio::time::sleep;
/// Defines the duration for which an Asset will remain cached after it's user has stopped using it.
/// The default is 1h (3600s).
#[derive(Hash, PartialEq, Eq, Clone)]
pub enum AssetAge {
/// Asset will be cached for the specified duration
Duration(Duration),
/// Asset will be cached until app is closed
Unspecified,
}
impl Default for AssetAge {
fn default() -> Self {
Self::Duration(Duration::from_secs(3600)) // 1h
}
}
impl From<Duration> for AssetAge {
fn from(value: Duration) -> Self {
Self::Duration(value)
}
}
/// Configuration for a given Asset.
#[derive(Hash, PartialEq, Eq, Clone)]
pub struct AssetConfiguration {
/// Asset age.
pub age: AssetAge,
/// The ID of the asset. For example: For images their source URL or path can be used as ID.
pub id: String,
}
enum AssetUsers {
Scopes(HashSet<ScopeId>),
ClearTask(Task),
}
struct AssetState {
users: AssetUsers,
asset_bytes: Signal<Bytes>,
}
#[derive(Clone, Copy, Default)]
pub struct AssetCacher {
registry: Signal<HashMap<AssetConfiguration, AssetState>>,
}
impl AssetCacher {
/// Cache the given [`AssetConfiguration`]
pub fn cache(
&mut self,
asset_config: AssetConfiguration,
asset_bytes: Bytes,
subscribe: bool,
) -> Signal<Bytes> {
// Cancel previous caches
if let Some(asset_state) = self.registry.write().remove(&asset_config) {
if let AssetUsers::ClearTask(task) = asset_state.users {
task.cancel();
asset_state.asset_bytes.manually_drop();
}
}
// Insert the asset into the cache
let value = ScopeId::ROOT.in_runtime(|| asset_bytes);
let asset_bytes = Signal::new_in_scope(value, ScopeId::ROOT);
self.registry.write().insert(
asset_config.clone(),
AssetState {
asset_bytes,
users: AssetUsers::Scopes(if subscribe {
HashSet::from([current_scope_id().unwrap()])
} else {
HashSet::default()
}),
},
);
asset_bytes
}
/// Stop using an asset. It will get removed after the specified duration if it's not used until then.
pub fn unuse_asset(&mut self, asset_config: AssetConfiguration) {
let mut registry = self.registry;
let spawn_clear_task = {
let mut registry = registry.write();
let entry = registry.get_mut(&asset_config);
if let Some(asset_state) = entry {
match &mut asset_state.users {
AssetUsers::Scopes(scopes) => {
// Unsub
scopes.remove(¤t_scope_id().unwrap());
// Only spawn a clear-task if there are no more scopes using this asset
scopes.is_empty()
}
AssetUsers::ClearTask(task) => {
// This case should never happen but... we leave it here anyway.
task.cancel();
true
}
}
} else {
false
}
};
if spawn_clear_task {
// Only clear the asset if a duration was specified
if let AssetAge::Duration(duration) = asset_config.age {
// Why not use `spawn_forever`? Reason: https://github.com/DioxusLabs/dioxus/issues/2215
let clear_task = spawn_forever({
let asset_config = asset_config.clone();
async move {
sleep(duration).await;
if let Some(asset_state) = registry.write().remove(&asset_config) {
// Clear the asset
asset_state.asset_bytes.manually_drop();
}
}
})
.unwrap();
// Registry the clear-task
let mut registry = registry.write();
let entry = registry.get_mut(&asset_config).unwrap();
entry.users = AssetUsers::ClearTask(clear_task);
}
}
}
/// Start using an Asset. Your scope will get subscribed, to stop using an asset use [`Self::unuse_asset`]
pub fn use_asset(&mut self, config: &AssetConfiguration) -> Option<Signal<Bytes>> {
let mut registry = self.registry.write();
if let Some(asset_state) = registry.get_mut(config) {
match &mut asset_state.users {
AssetUsers::ClearTask(task) => {
// Cancel clear-tasks
task.cancel();
asset_state.asset_bytes.manually_drop();
// Start using this asset
asset_state.users =
AssetUsers::Scopes(HashSet::from([current_scope_id().unwrap()]));
}
AssetUsers::Scopes(scopes) => {
// Start using this asset
scopes.insert(current_scope_id().unwrap());
}
}
}
registry.get(config).map(|s| s.asset_bytes)
}
/// Get the size of the cache registry.
pub fn size(&self) -> usize {
self.registry.read().len()
}
/// Clear all the assets from the cache registry.
pub fn clear(&mut self) {
self.registry.try_write().unwrap().clear();
}
}
/// Global caching system for assets.
///
/// This is a "low level" hook, so you probably won't need it.
pub fn use_asset_cacher() -> AssetCacher {
use_context()
}
/// Initialize the global caching system for assets.
///
/// This is a "low level" hook, so you probably won't need it.
pub fn use_init_asset_cacher() {
use_context_provider(AssetCacher::default);
}