Struct bevy_persistent::persistent::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: 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> FromReflect for Persistent<R>where String: FromReflect, StorageFormat: FromReflect, Storage: FromReflect, Option<R>: FromReflect, Option<Box<R>>: FromReflect, bool: FromReflect, R: TypePath + Resource + Serialize + DeserializeOwned,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect, Global> ) -> Result<Self, Box<dyn Reflect, Global>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<R> GetTypeRegistration for Persistent<R>where String: FromReflect, StorageFormat: FromReflect, Storage: FromReflect, Option<R>: FromReflect, Option<Box<R>>: FromReflect, bool: FromReflect, R: TypePath + Resource + Serialize + DeserializeOwned,

fn get_type_registration() -> TypeRegistration

impl<R> Reflect for Persistent<R>where String: FromReflect, StorageFormat: FromReflect, Storage: FromReflect, Option<R>: FromReflect, Option<Box<R>>: FromReflect, bool: FromReflect, R: TypePath + Resource + Serialize + DeserializeOwned,

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the [TypeInfo] of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<R> Struct for Persistent<R>where String: FromReflect, StorageFormat: FromReflect, Storage: FromReflect, Option<R>: FromReflect, Option<Box<R>>: FromReflect, bool: FromReflect, R: TypePath + Resource + Serialize + DeserializeOwned,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl<R> TypePath for Persistent<R>where String: FromReflect, StorageFormat: FromReflect, Storage: FromReflect, Option<R>: FromReflect, Option<Box<R>>: FromReflect, bool: FromReflect, R: TypePath + Resource + Serialize + DeserializeOwned,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the moudle the type is in, or None if it is anonymous.

impl<R> Typed for Persistent<R>where String: FromReflect, StorageFormat: FromReflect, Storage: FromReflect, Option<R>: FromReflect, Option<Box<R>>: FromReflect, bool: FromReflect, R: TypePath + Resource + Serialize + DeserializeOwned,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<R: Resource + Serialize + DeserializeOwned> Resource for Persistent<R>where Self: Send + Sync + 'static,