bevy_archive 0.3.0

An experimental ECS world snapshot system built on Bevy, featuring structured archetype storage and manifest-based serialization.
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

use bevy_ecs::prelude::World;
use std::path::Path;

use crate::bevy_registry::{SnapshotRegistry, IDRemapRegistry, EntityRemapper};

/// A common trait for all Bevy archive formats.
pub trait Archive: Sized {
    /// Create an in-memory archive from the World.
    fn create(
        world: &World,
        registry: &SnapshotRegistry,
    ) -> Result<Self, Box<dyn std::error::Error + Send + Sync>>;

    /// Apply the archive content to the World.
    fn apply(
        &self,
        world: &mut World,
        registry: &SnapshotRegistry,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>>;
    
    /// Apply the archive content with entity remapping.
    fn apply_with_remap(
        &self,
        _world: &mut World,
        _registry: &SnapshotRegistry,
        _id_registry: &IDRemapRegistry,
        _mapper: &dyn EntityRemapper,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        Err("Remapping not implemented for this archive format".into())
    }

    /// Save the archive to a file.
    fn save_to(
        &self,
        path: impl AsRef<Path>,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>>;

    /// Load the archive from a file.
    fn load_from(
        path: impl AsRef<Path>,
    ) -> Result<Self, Box<dyn std::error::Error + Send + Sync>>;

    /// Get all entity IDs present in this archive.
    fn get_entities(&self) -> Vec<u32> {
        vec![]
    }

    /// Manually load resources from the archive into the world.
    fn load_resources(
        &self,
        _world: &mut World,
        _registry: &SnapshotRegistry,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        Ok(())
    }
}