Struct bones_framework::storage::Storage

pub struct Storage {
    pub backend: Box<dyn StorageApi>,
    pub cache: HashMap<SchemaId, SchemaBox>,
}

Persitent storage resource.

Note: data is not actually saved until you call Storage::save

🚧 Warning: The storage interface uses the types SchemaData::full_name as a storage key, so you must ensure that all types that are stored have different full names or it may behave unexpectedly.

Fields

backend: Box<dyn StorageApi>

The backend storage API.

cache: HashMap<SchemaId, SchemaBox>

The cache of objects that have been read

Implementations

impl Storage

pub fn with_backend(backend: Box<dyn StorageApi>) -> Self

Create a new storage resource with the given backend storage API.

pub fn load(&mut self)

Load the data from the storage backend.

pub fn save(&mut self)

Save the data to the storage backend.

pub fn insert<T: HasSchema>(&mut self, data: T)

Insert the data into storage cache.

pub fn get<T: HasSchema>(&self) -> Option<&T>

Get data from the storage cache.

pub fn get_mut<T: HasSchema>(&mut self) -> Option<&mut T>

Get data mutably from the storage cache.

pub fn get_or_insert_default<T: HasSchema + Default>(&mut self) -> &T

Get data from the storage cache or insert it’s default value

pub fn get_or_insert_default_mut<T: HasSchema + Default>(&mut self) -> &mut T

Get data mutably from the storage cache or insert it’s default value

pub fn remove<T: HasSchema>(&mut self)

Remove data for a type from the storage.

Trait Implementations

impl Default for Storage

fn default() -> Self

Returns the “default value” for a type.

impl HasSchema for Storage

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut