Conveniently load, store and cache external resources.
It has multiple goals:
- Easy to use
- Light: Pay for what you take, no dependency bloat
- Fast: Share your resources between threads without using expensive Arc::clone
This crate follow semver convention and supports rustc 1.42.0 and higher. Changing this is considered a breaking change.
Note: this crate is still under developpement and breaking changes will happen in the future, but use, feedbacks and requests are welcome and encouraged.
Suppose that you have a file assets/common/test.ron containing this:
text
Point(
x: 5,
y: -6,
)
Then you can load it this way (with feature ron enabled):
```rust use assets_manager::{Asset, AssetCache, loader}; use serde::Deserialize;
// The struct you want to load
struct Point { x: i32, y: i32, }
// Specify how you want the structure to be loaded impl Asset for Point { // The extension of the files to look into const EXT: &'static str = "ron";
// The serialization format
type Loader = loader::RonLoader;
}
// Create a new cache to load assets under the "./assets" folder let cache = AssetCache::new("assets");
// Get a lock on the asset
// This will load the file ./assets/common/test.ron
let asset_lock = cache.load::
// Lock the asset for reading // Any number of read locks can exist at the same time, // but none can exist when the asset is reloaded let point = asset_lock.read();
// The asset is now ready to be used asserteq!(point.x, 5); asserteq!(point.y, -6);
// Loading the same asset retreives it from the cache let otherlock = cache.load("common.test")?; assert!(assetlock.ptreq(&otherlock)); ```
Hot-reloading is also very easy to use:
```rust
let cache = AssetCache::new("assets");
let asset_lock = cache.load::
loop { println!("Current value: {:?}", assetlock.read()); cache.hotreload(); } ```
Current features: - Convenient load of external files - Cache loaded assets - Hot-reloading - Built-in support of most common data formats with serde
Planned features: - Load from different sources (archives, embeded)
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.