distill-loader 0.0.2

Loader component of the asset pipeline `distill`.
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

#![warn(rust_2018_idioms, rust_2018_compatibility)]

/// *feature:* `handle`. Handles provide automatic reference counting of assets, similar to [Rc](`std::rc::Rc`).
#[cfg(feature = "handle")]
pub mod handle;
/// [`LoaderIO`](crate::io::LoaderIO) provides data requested by [`Loader`](crate::loader::Loader).
pub mod io;
/// [`Loader`] loads assets into engine-implemented [`AssetStorage`](crate::storage::AssetStorage)s.
pub mod loader;
#[cfg(feature = "packfile_io")]
pub mod packfile_io;
/// *feature:* `rpc_io`. `RpcIO` is an implementation of [`LoaderIO`](crate::io::LoaderIO) which communicates with `distill_daemon`
/// to load and hot reload assets. Intended for development workflows.
#[cfg(feature = "rpc_io")]
pub mod rpc_io;
/// [`AssetStorage`](crate::storage::AssetStorage) is implemented by engines to store loaded asset data.
pub mod storage;

pub use crossbeam_channel;
pub use distill_core::{AssetRef, AssetTypeId, AssetUuid};
pub use loader::Loader;
#[cfg(feature = "packfile_io")]
pub use packfile_io::PackfileReader;
#[cfg(feature = "rpc_io")]
pub use rpc_io::RpcIO;
pub use storage::LoadHandle;

pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + 'static>>;

#[cfg(feature = "handle")]
#[macro_export]
macro_rules! if_handle_enabled {
    ($($tt:tt)*) => {
        $($tt)*
    };
}

#[cfg(not(feature = "handle"))]
#[macro_export]
#[doc(hidden)]
macro_rules! if_handle_enabled {
    ($($tt:tt)*) => {};
}