mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 06:30:19 +00:00
dd46fd3aee
# Objective - Fixes #8140 ## Solution - Added Explicit Error Typing for `AssetLoader` and `AssetSaver`, which were the last instances of `anyhow` in use across Bevy. --- ## Changelog - Added an associated type `Error` to `AssetLoader` and `AssetSaver` for use with the `load` and `save` methods respectively. - Changed `ErasedAssetLoader` and `ErasedAssetSaver` `load` and `save` methods to use `Box<dyn Error + Send + Sync + 'static>` to allow for arbitrary `Error` types from the non-erased trait variants. Note the strict requirements match the pre-existing requirements around `anyhow::Error`. ## Migration Guide - `anyhow` is no longer exported by `bevy_asset`; Add it to your own project (if required). - `AssetLoader` and `AssetSaver` have an associated type `Error`; Define an appropriate error type (e.g., using `thiserror`), or use a pre-made error type (e.g., `anyhow::Error`). Note that using `anyhow::Error` is a drop-in replacement. - `AssetLoaderError` has been removed; Define a new error type, or use an alternative (e.g., `anyhow::Error`) - All the first-party `AssetLoader`'s and `AssetSaver`'s now return relevant (and narrow) error types instead of a single ambiguous type; Match over the specific error type, or encapsulate (`Box<dyn>`, `thiserror`, `anyhow`, etc.) ## Notes A simpler PR to resolve this issue would simply define a Bevy `Error` type defined as `Box<dyn std::error::Error + Send + Sync + 'static>`, but I think this type of error handling should be discouraged when possible. Since only 2 traits required the use of `anyhow`, it isn't a substantive body of work to solidify these error types, and remove `anyhow` entirely. End users are still encouraged to use `anyhow` if that is their preferred error handling style. Arguably, adding the `Error` associated type gives more freedom to end-users to decide whether they want more or less explicit error handling (`anyhow` vs `thiserror`). As an aside, I didn't perform any testing on Android or WASM. CI passed locally, but there may be mistakes for those platforms I missed.
86 lines
2.2 KiB
Rust
86 lines
2.2 KiB
Rust
//! Implements loader for a custom asset type.
|
|
|
|
use bevy::utils::thiserror;
|
|
use bevy::{
|
|
asset::{io::Reader, AssetLoader, LoadContext},
|
|
prelude::*,
|
|
reflect::TypePath,
|
|
utils::BoxedFuture,
|
|
};
|
|
use futures_lite::AsyncReadExt;
|
|
use serde::Deserialize;
|
|
use thiserror::Error;
|
|
|
|
#[derive(Asset, TypePath, Debug, Deserialize)]
|
|
pub struct CustomAsset {
|
|
pub value: i32,
|
|
}
|
|
|
|
#[derive(Default)]
|
|
pub struct CustomAssetLoader;
|
|
|
|
/// Possible errors that can be produced by [`CustomAssetLoader`]
|
|
#[non_exhaustive]
|
|
#[derive(Debug, Error)]
|
|
pub enum CustomAssetLoaderError {
|
|
/// An [IO](std::io) Error
|
|
#[error("Could load shader: {0}")]
|
|
Io(#[from] std::io::Error),
|
|
/// A [RON](ron) Error
|
|
#[error("Could not parse RON: {0}")]
|
|
RonSpannedError(#[from] ron::error::SpannedError),
|
|
}
|
|
|
|
impl AssetLoader for CustomAssetLoader {
|
|
type Asset = CustomAsset;
|
|
type Settings = ();
|
|
type Error = CustomAssetLoaderError;
|
|
fn load<'a>(
|
|
&'a self,
|
|
reader: &'a mut Reader,
|
|
_settings: &'a (),
|
|
_load_context: &'a mut LoadContext,
|
|
) -> BoxedFuture<'a, Result<Self::Asset, Self::Error>> {
|
|
Box::pin(async move {
|
|
let mut bytes = Vec::new();
|
|
reader.read_to_end(&mut bytes).await?;
|
|
let custom_asset = ron::de::from_bytes::<CustomAsset>(&bytes)?;
|
|
Ok(custom_asset)
|
|
})
|
|
}
|
|
|
|
fn extensions(&self) -> &[&str] {
|
|
&["custom"]
|
|
}
|
|
}
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.init_resource::<State>()
|
|
.init_asset::<CustomAsset>()
|
|
.init_asset_loader::<CustomAssetLoader>()
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, print_on_load)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Resource, Default)]
|
|
struct State {
|
|
handle: Handle<CustomAsset>,
|
|
printed: bool,
|
|
}
|
|
|
|
fn setup(mut state: ResMut<State>, asset_server: Res<AssetServer>) {
|
|
state.handle = asset_server.load("data/asset.custom");
|
|
}
|
|
|
|
fn print_on_load(mut state: ResMut<State>, custom_assets: ResMut<Assets<CustomAsset>>) {
|
|
let custom_asset = custom_assets.get(&state.handle);
|
|
if state.printed || custom_asset.is_none() {
|
|
return;
|
|
}
|
|
|
|
info!("Custom asset loaded: {:?}", custom_asset.unwrap());
|
|
state.printed = true;
|
|
}
|