Struct Persistent

pub struct Persistent<R: Resource + Serialize + DeserializeOwned> { /* private fields */ }

A persistent resource.

Persistent resources are Bevy resources which are automatically synchronized with the disk.

They require a name for logging, a path to be saved to and loaded from, a storage format, and a default resource in case the persistent resource is created for the first time.

They are synchronized with the disk from the moment of their creation.

Implementations

impl<R: Resource + Serialize + DeserializeOwned> Persistent<R>

pub fn builder() -> PersistentBuilder<R>

Creates a persistent resource builder.

pub fn new( name: impl ToString, format: StorageFormat, storage: Storage, loaded: bool, default: R, revertible: bool, revert_to_default_on_deserialization_errors: bool, ) -> Result<Persistent<R>, PersistenceError>

Creates a persistent resource.

Panics

Panics if revert_to_default_on_deserialization_errors is set to true but revertible is set to false.

impl<R: Resource + Serialize + DeserializeOwned> Persistent<R>

pub fn name(&self) -> &str

Gets the name of the resource.

pub fn format(&self) -> StorageFormat

Gets the storage format of the resource.

pub fn storage(&self) -> &Storage

Gets the storage of the resource.

pub fn is_revertible(&self) -> bool

Gets if the resource is revertible.

pub fn is_loaded(&self) -> bool

Gets if the resource is loaded.

pub fn is_unloaded(&self) -> bool

Gets if the resource is unloaded.

pub fn get(&self) -> &R

Gets the resource.

Panics

Panics if the resource is unloaded.

pub fn get_mut(&mut self) -> &mut R

Gets the resource mutably.

Panics

Panics if the resource is unloaded.

pub fn try_get(&self) -> Option<&R>

Tries to get the resource.

pub fn try_get_mut(&mut self) -> Option<&mut R>

Tries to get the resource mutably.

impl<R: Resource + Serialize + DeserializeOwned> Persistent<R>

pub fn set(&mut self, new_resource: R) -> Result<(), PersistenceError>

Sets the resource.

Changes are synchronized with the underlying storage immediately.

pub fn update( &mut self, updater: impl Fn(&mut R), ) -> Result<(), PersistenceError>

Updates the resource.

Changes are synchronized with the underlying storage immediately.

Panics

Panics if the resource is unloaded.

pub fn unload(&mut self) -> Result<(), PersistenceError>

Unloads the resource from memory.

Changes are synchronized with the underlying storage before unloading.

Panics

Panics if the resource is unloaded.

pub fn unload_without_persisting(&mut self)

Unloads the resource from memory immediately.

Changes are not synchronized with the underlying storage before unloading.

pub fn reload(&mut self) -> Result<(), PersistenceError>

Reloads the resource from the underlying storage.

If reloading fails, the underlying resource is kept untouched.

pub fn revert_to_default(&mut self) -> Result<(), PersistenceError>

Reverts the resource to it’s default value.

Loaded status is kept upon reloading.

Panics

Panics if the resource is not revertible.

pub fn revert_to_default_in_memory(&mut self) -> Result<(), PersistenceError>

Reverts the resource to it’s default value only in memory, not persistent storage.

Panics

Panics if the resource is not revertible.

impl<R: Resource + Serialize + DeserializeOwned> Persistent<R>

pub fn persist(&self) -> Result<(), PersistenceError>

Writes the resource to the underlying storage.

Panics

Panics if the resource is unloaded.

Trait Implementations

impl<R: Resource + Serialize + DeserializeOwned> Component for Persistent<R>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<R: Debug + Resource + Serialize + DeserializeOwned> Debug for Persistent<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Resource + Serialize + DeserializeOwned> Deref for Persistent<R>

type Target = R

The resulting type after dereferencing.

fn deref(&self) -> &R

Dereferences the value.

impl<R: Resource + Serialize + DeserializeOwned> DerefMut for Persistent<R>

fn deref_mut(&mut self) -> &mut R

Mutably dereferences the value.

impl<R: Resource + Serialize + DeserializeOwned> Resource for Persistent<R>

where Self: Send + Sync + 'static,