chuot 0.3.2

AGPL licensed and opinionated game engine for pixel-art 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Any asset that can be loaded with [`crate::assets::loader::Loader`] implementations.

pub(crate) mod audio;
pub(crate) mod font;
pub(crate) mod shader;
pub(crate) mod sprite;

use downcast_rs::Downcast;

use super::Id;
use crate::context::ContextInner;

/// Any asset that's loadable from any amount of binary files.
///
/// # Example
///
/// ```
/// use chuot::{
///     assets::{Id, loadable::Loadable, loader::ron::RonLoader},
///     context::ContextInner,
/// };
/// use nanoserde::DeRon;
///
/// /// We define a custom settings object that will be loaded from a '.ron' file.
/// #[derive(DeRon)]
/// struct Settings {
///     property_a: String,
///     property_b: i32,
/// }
///
/// impl Loadable for Settings {
///     fn load_if_exists(id: &Id, ctx: &mut ContextInner) -> Option<Self> {
///         // Use the RON loader to load our asset
///         ctx.asset_source.load_if_exists::<RonLoader, Self>(id)
///     }
/// }
/// ```
pub trait Loadable: Downcast {
    /// Convert a file object to this type if it exists, if it doesn't return `None`.
    ///
    /// # Panics
    ///
    /// - When parsing binary bytes of asset into type fails.
    fn load_if_exists(id: &Id, ctx: &mut ContextInner) -> Option<Self>
    where
        Self: Sized;

    /// Convert a file object to this type.
    ///
    /// # Panics
    ///
    /// - When parsing binary bytes of asset into type fails.
    /// - When asset does not exist in the source.
    #[inline]
    #[must_use]
    fn load(id: &Id, ctx: &mut ContextInner) -> Self
    where
        Self: Sized,
    {
        Self::load_if_exists(id, ctx)
            .unwrap_or_else(|| panic!("Error loading asset: '{id}' does not exist"))
    }

    /// Create a new runtime asset from the default value.
    #[inline]
    #[must_use]
    fn new() -> Self
    where
        Self: Default,
    {
        Self::default()
    }
}
downcast_rs::impl_downcast!(Loadable);