keket 0.20.3

Database-like Asset management on top of ECS storage
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

pub mod file;
pub mod future;

use crate::database::{
    events::{AssetEvent, AssetEventBindings, AssetEventKind},
    handle::AssetHandle,
    path::AssetPath,
};
use anput::{bundle::DynamicBundle, world::World};
use std::error::Error;

/// Marker type for assets that are awaiting storing.
pub struct AssetAwaitsStoring;

/// Represents raw byte data that is ready to be stored.
#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub struct AssetBytesAreReadyToStore(pub Vec<u8>);

/// Marker component used to signify that the asset store for an asset is
/// asynchronous and it's pending completion.
pub struct AssetAwaitsAsyncStore;

/// Defines the interface for storing asset data to an external source.
pub trait AssetStore: Send + Sync + 'static {
    /// Saves the raw bytes of an asset given its path.
    ///
    /// # Arguments
    /// - `path`: The path to the asset.
    /// - `bytes`: The byte data to be saved.
    ///
    /// # Returns
    /// - A `DynamicBundle` containing additional asset data or an error if saving fails.
    fn save_bytes(&self, path: AssetPath, bytes: Vec<u8>) -> Result<DynamicBundle, Box<dyn Error>>;

    /// Maintains the store's state.
    ///
    /// Can be used for handling periodic or deferred operations.
    ///
    /// # Arguments
    /// - `storage`: The world storage where asset state is maintained.
    ///
    /// # Returns
    /// - `Ok(())` if maintenance succeeds, otherwise an error.
    #[allow(unused_variables)]
    fn maintain(&mut self, storage: &mut World) -> Result<(), Box<dyn Error>> {
        Ok(())
    }
}

pub(crate) struct AssetStoreEngine {
    store: Box<dyn AssetStore>,
}

impl AssetStoreEngine {
    pub fn new(store: impl AssetStore) -> Self {
        Self {
            store: Box::new(store),
        }
    }

    pub fn into_inner(self) -> Box<dyn AssetStore> {
        self.store
    }

    pub fn save_bytes(
        &self,
        handle: AssetHandle,
        path: AssetPath,
        bytes: Vec<u8>,
        storage: &mut World,
    ) -> Result<(), Box<dyn Error>> {
        let result = self.store.save_bytes(path.clone(), bytes);
        if result.is_err()
            && let Ok(mut bindings) =
                storage.component_mut::<true, AssetEventBindings>(handle.entity())
        {
            bindings.dispatch(AssetEvent {
                handle,
                kind: AssetEventKind::BytesStoringFailed,
                path: path.into_static(),
            })?;
        }
        storage.insert(handle.entity(), result?)?;
        Ok(())
    }

    pub fn maintain(&mut self, storage: &mut World) -> Result<(), Box<dyn Error>> {
        self.store.maintain(storage)
    }
}