bevy_save 2.0.1+4

A framework for saving and loading application state in Bevy.
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

// `rustdoc_internals` is needed for `#[doc(fake_variadics)]`
#![allow(unexpected_cfgs)]
#![allow(internal_features)]
#![cfg_attr(any(docsrs, docsrs_dep), feature(doc_auto_cfg, rustdoc_internals))]
#![warn(missing_docs)]
#![warn(clippy::pedantic)]
#![warn(clippy::undocumented_unsafe_blocks)]
#![allow(clippy::module_name_repetitions)]
#![allow(clippy::module_inception)]
#![allow(clippy::must_use_candidate)]
#![allow(clippy::redundant_closure_for_method_calls)]
#![allow(clippy::return_self_not_must_use)]
#![allow(clippy::too_many_lines)]
#![doc = include_str!("../README.md")]

pub mod backend;
pub mod dir;
mod error;
pub mod flows;
pub mod format;
pub mod middleware;
pub mod plugins;
mod utils;

/// `bevy_save` crate version
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

#[cfg(feature = "reflect")]
/// `bevy_save` snapshot version
pub const SNAPSHOT_VERSION: reflect::SnapshotVersion = reflect::SnapshotVersion::V4;

#[cfg(feature = "reflect")]
pub mod reflect;

#[cfg(feature = "reflect")]
pub use crate::reflect::clone_reflect_value;
pub use crate::{
    error::Error,
    utils::{
        IntoVersion,
        MaybeMut,
        MaybeRef,
    },
};

/// Prelude: convenient import for commonly used items provided by the crate.
#[allow(unused_imports)]
pub mod prelude {
    pub use bevy_save_macros::FlowLabel;

    #[cfg(all(feature = "reflect", feature = "checkpoints"))]
    #[doc(inline)]
    pub use crate::reflect::checkpoint::{
        AppCheckpointExt,
        WorldCheckpointExt,
    };
    #[cfg(feature = "reflect")]
    #[doc(inline)]
    pub use crate::reflect::{
        Pipeline,
        migration::{
            Migrate,
            Migrator,
            ReflectMigrate,
        },
        pipeline::AppPipelineExt,
        prefab::{
            CommandsPrefabExt,
            Prefab,
            WithPrefab,
        },
        snapshot::{
            Applier,
            ApplierRef,
            BoxedHook,
            Builder,
            BuilderRef,
            Hook,
            Snapshot,
        },
    };
    #[doc(inline)]
    pub use crate::{
        backend::{
            AppBackendExt,
            Backend,
            DefaultBackend,
            DefaultDebugBackend,
        },
        dir::{
            SAVE_DIR,
            WORKSPACE,
            get_save_file,
        },
        error::Error,
        flows::{
            AppFlowExt,
            Flow,
            FlowLabel,
            FlowSystem,
            Flows,
            IntoFlowSystems,
            pathway::{
                AppPathwayExt,
                CaptureDeserialize,
                CaptureInput,
                CaptureOutput,
                CaptureSerialize,
                Pathway,
                WorldPathwayExt,
            },
        },
        format::{
            DefaultDebugFormat,
            DefaultFormat,
            Format,
        },
        middleware::*,
        plugins::{
            SavePlugin,
            SavePlugins,
        },
    };
}