extendable-assets 0.1.0

Asset framework for graphics and games
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

use std::sync::Arc;

use crate::asset::AssetData;
use crate::manager::AssetManagerContext;

use thiserror::Error;

/// Errors that can occur during asset saving.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum AssetSaveError {
    /// The asset type is not supported by this saver.
    #[error("Unsupported asset type")]
    UnsupportedType,

    /// Failed to serialize the asset data to bytes.
    #[error("Serialization error: {0}")]
    Serialization(anyhow::Error),

    /// Any other error that occurred during saving.
    #[error(transparent)]
    Other(anyhow::Error),
}

/// Trait for saving asset data to raw byte data.
///
/// Asset savers are responsible for converting typed asset data back into raw bytes
/// that can be written to files or transmitted over the network.
pub trait AssetDataSaver {
    /// Converts asset data into raw bytes.
    ///
    /// This method is called by the asset manager when an asset needs to be
    /// saved to persistent storage or transmitted over the network.
    ///
    /// # Arguments
    ///
    /// * `asset` - The asset data to serialize into bytes
    /// * `context` - Optional context providing access to asset manager state
    ///   and configuration during the saving process
    ///
    /// # Returns
    ///
    /// The serialized byte data on success, or an error if saving failed.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// * The asset type is not supported by this saver
    /// * Serialization of the asset data fails
    /// * Any other error occurs during the saving process
    fn asset_to_bytes(
        &self,
        asset: &dyn AssetData,
        context: Option<Arc<dyn AssetManagerContext>>,
    ) -> Result<Vec<u8>, AssetSaveError>;
}