Skip to content

Implement minimal asset saving #22622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andriyDev wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Implement minimal asset saving #22622

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2774b67
Rewrite `SavedAsset` to borrow each asset individually.
andriyDev Jan 20, 2026
2f32e8b
Implement asset saving.
andriyDev Jan 20, 2026
77e739d
Switch `AssetSaver` to use `Into<BevyError>` for the error type to ma…
andriyDev Jan 21, 2026
739777b
Create an example for demonstrating how to do asset saving.
andriyDev Jan 21, 2026
fd5f262
Allow `SavedAssetBuilder::labeled_assets` to store owned strings.
andriyDev Jan 21, 2026
77a14a9
Add migration guide and release notes.
andriyDev Jan 21, 2026
9937dc7
Add `must_use` on `add_labeled_asset_with_new_handle*`.
andriyDev Jan 23, 2026
18da29b
Improve the documentation of the `add_labeled_asset_with_new_handle` …
andriyDev Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 5 additions & 42 deletions crates/bevy_asset/src/processor/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ use crate::{
AssetProcessor, GetProcessorError, LoadTransformAndSave, LogEntry, Process, ProcessContext,
ProcessError, ProcessorState, ProcessorTransactionLog, ProcessorTransactionLogFactory,
},
saver::AssetSaver,
saver::{tests::CoolTextSaver, AssetSaver},
tests::{
read_asset_as_string, read_meta_as_string, run_app_until, CoolText, CoolTextLoader,
CoolTextRon, SubText,
Expand Down Expand Up @@ -426,43 +426,6 @@ fn run_app_until_finished_processing(app: &mut App, guard: RwLockWriteGuard<'_,
});
}

#[derive(TypePath)]
struct CoolTextSaver;

impl AssetSaver for CoolTextSaver {
type Asset = CoolText;
type Settings = ();
type OutputLoader = CoolTextLoader;
type Error = std::io::Error;

async fn save(
&self,
writer: &mut crate::io::Writer,
asset: crate::saver::SavedAsset<'_, Self::Asset>,
_: &Self::Settings,
) -> Result<(), Self::Error> {
let ron = CoolTextRon {
text: asset.text.clone(),
sub_texts: asset
.iter_labels()
.map(|label| asset.get_labeled::<SubText, _>(label).unwrap().text.clone())
.collect(),
dependencies: asset
.dependencies
.iter()
.map(|handle| handle.path().unwrap().path())
.map(|path| path.to_str().unwrap().to_string())
.collect(),
// NOTE: We can't handle embedded dependencies in any way, since we need to write to
// another file to do so.
embedded_dependencies: vec![],
};
let ron = ron::ser::to_string_pretty(&ron, PrettyConfig::new().new_line("\n")).unwrap();
writer.write_all(ron.as_bytes()).await?;
Ok(())
}
}

// Note: while we allow any Fn, since closures are unnameable types, creating a processor with a
// closure cannot be used (since we need to include the name of the transformer in the meta
// file).
Expand Down Expand Up @@ -637,7 +600,7 @@ fn asset_processor_transforms_asset_with_meta() {
source_dir.insert_meta_text(path, r#"(
meta_format_version: "1.0",
asset: Process(
processor: "bevy_asset::processor::process::LoadTransformAndSave<bevy_asset::tests::CoolTextLoader, bevy_asset::processor::tests::RootAssetTransformer<bevy_asset::processor::tests::AddText, bevy_asset::tests::CoolText>, bevy_asset::processor::tests::CoolTextSaver>",
processor: "bevy_asset::processor::process::LoadTransformAndSave<bevy_asset::tests::CoolTextLoader, bevy_asset::processor::tests::RootAssetTransformer<bevy_asset::processor::tests::AddText, bevy_asset::tests::CoolText>, bevy_asset::saver::tests::CoolTextSaver>",
settings: (
loader_settings: (),
transformer_settings: (),
Expand Down Expand Up @@ -846,7 +809,7 @@ impl AssetSaver for FakeBsnSaver {
async fn save(
&self,
writer: &mut crate::io::Writer,
asset: crate::saver::SavedAsset<'_, Self::Asset>,
asset: crate::saver::SavedAsset<'_, '_, Self::Asset>,
_settings: &Self::Settings,
) -> Result<(), Self::Error> {
use std::io::{Error, ErrorKind};
Expand Down Expand Up @@ -1336,7 +1299,7 @@ fn nested_loads_of_processed_asset_reprocesses_on_reload() {
async fn save(
&self,
writer: &mut crate::io::Writer,
asset: crate::saver::SavedAsset<'_, Self::Asset>,
asset: crate::saver::SavedAsset<'_, '_, Self::Asset>,
_settings: &Self::Settings,
) -> Result<<Self::OutputLoader as AssetLoader>::Settings, Self::Error> {
let serialized = serialize_as_leaf(asset.get().value.clone());
Expand Down Expand Up @@ -1759,7 +1722,7 @@ fn writes_default_meta_for_processor() {
r#"(
meta_format_version: "1.0",
asset: Process(
processor: "bevy_asset::processor::process::LoadTransformAndSave<bevy_asset::tests::CoolTextLoader, bevy_asset::processor::tests::RootAssetTransformer<bevy_asset::processor::tests::AddText, bevy_asset::tests::CoolText>, bevy_asset::processor::tests::CoolTextSaver>",
processor: "bevy_asset::processor::process::LoadTransformAndSave<bevy_asset::tests::CoolTextLoader, bevy_asset::processor::tests::RootAssetTransformer<bevy_asset::processor::tests::AddText, bevy_asset::tests::CoolText>, bevy_asset::saver::tests::CoolTextSaver>",
settings: (
loader_settings: (),
transformer_settings: (),
Expand Down
Loading