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 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
//! A persistent resource.
use crate::prelude::*;
/// 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.
#[derive(Component, Debug, Resource)]
pub struct Persistent<R: Resource + Serialize + DeserializeOwned> {
pub(crate) name: String,
pub(crate) format: StorageFormat,
pub(crate) storage: Storage,
pub(crate) resource: Option<R>,
pub(crate) default: Option<Box<R>>,
pub(crate) revert_to_default_on_deserialization_errors: bool,
}
impl<R: Resource + Serialize + DeserializeOwned> Persistent<R> {
/// Creates a persistent resource builder.
pub fn builder() -> PersistentBuilder<R> {
PersistentBuilder {
name: None,
format: None,
path: None,
loaded: true,
default: None,
revertible: false,
revert_to_default_on_deserialization_errors: false,
}
}
/// Creates a persistent resource.
///
/// # Panics
///
/// Panics if `revert_to_default_on_deserialization_errors`
/// is set to `true` but `revertible` is set to `false`.
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> {
if revert_to_default_on_deserialization_errors && !revertible {
panic!(
"revert to default on deserialization errors \
is set for a non-revertible persistent resource"
);
}
let name = name.to_string();
if !storage.occupied() {
// first run
storage.initialize().map_err(|error| {
// initialize can only return error for filesystem storage
log::error!(
"failed to create the parent directory for {} at {}: {}",
name,
storage,
error,
);
error
})?;
storage
.write(&name, format, &default)
.map(|_| {
log::info!("saved default {} to {}", name, storage);
})
.map_err(|error| {
// serialization errors are already logged
if !error.is_serde() {
log::error!("failed to save default {} to {}: {}", name, storage, error);
} else {
log::error!(
"failed to save default {} to {} due to a serialization error",
name,
storage,
);
}
error
})?;
let resource = if loaded {
// we need to make a copy of the default resource without using clone
// this is because cloning can have special semantics
// e.g., cloning Persistent<Arc<RwLock<R>>> and changing it
// would change the default object, which is not desired
let serialized = format.serialize(&name, &default).map_err(|error| {
log::error!("failed to clone default {} due to a serialization error", name);
error
})?;
let reconstructed = format.deserialize(&name, &serialized).map_err(|error| {
log::error!("failed to clone default {} due to a deserialization error", name);
error
})?;
Some(reconstructed)
} else {
None
};
let default = if revertible { Some(Box::new(default)) } else { None };
return Ok(Persistent {
name,
format,
storage,
resource,
default,
revert_to_default_on_deserialization_errors,
});
}
let default = if revertible { Some(Box::new(default)) } else { None };
if !loaded {
return Ok(Persistent {
name,
format,
storage,
resource: None,
default,
revert_to_default_on_deserialization_errors,
});
}
let resource = match storage.read(&name, format) {
Ok(resource) => resource,
Err(error) => {
if !error.is_serde() {
log::error!("failed to load {} from {}: {}", name, storage, error);
} else {
log::error!(
"failed to load {} from {} due to a deserialization error",
name,
storage,
);
if revert_to_default_on_deserialization_errors {
log::info!(
"attempting to revert {} to default in {} automatically",
name,
storage,
);
let mut result = Persistent {
name,
format,
storage,
resource: None,
default,
revert_to_default_on_deserialization_errors,
};
if result.revert_to_default().is_err() {
// return the original deserialization error
return Err(error);
}
if loaded && result.revert_to_default_in_memory().is_err() {
// return the original deserialization error
return Err(error);
}
return Ok(result);
}
}
return Err(error);
},
};
log::info!("loaded {} from {}", name, storage);
Ok(Persistent {
name,
format,
storage,
resource: Some(resource),
default,
revert_to_default_on_deserialization_errors,
})
}
}
impl<R: Resource + Serialize + DeserializeOwned> Persistent<R> {
/// Gets the name of the resource.
pub fn name(&self) -> &str {
&self.name
}
/// Gets the storage format of the resource.
pub fn format(&self) -> StorageFormat {
self.format
}
/// Gets the storage of the resource.
pub fn storage(&self) -> &Storage {
&self.storage
}
/// Gets if the resource is revertible.
pub fn is_revertible(&self) -> bool {
self.default.is_some()
}
/// Gets if the resource is loaded.
pub fn is_loaded(&self) -> bool {
self.resource.is_some()
}
/// Gets if the resource is unloaded.
pub fn is_unloaded(&self) -> bool {
self.resource.is_none()
}
/// Gets the resource.
///
/// # Panics
///
/// Panics if the resource is unloaded.
pub fn get(&self) -> &R {
if let Some(resource) = &self.resource {
resource
} else {
panic!("tried to get unloaded {}", self.name);
}
}
/// Gets the resource mutably.
///
/// # Panics
///
/// Panics if the resource is unloaded.
pub fn get_mut(&mut self) -> &mut R {
if let Some(resource) = &mut self.resource {
resource
} else {
panic!("tried to get unloaded {} mutably", self.name);
}
}
/// Tries to get the resource.
pub fn try_get(&self) -> Option<&R> {
self.resource.as_ref()
}
/// Tries to get the resource mutably.
pub fn try_get_mut(&mut self) -> Option<&mut R> {
self.resource.as_mut()
}
}
impl<R: Resource + Serialize + DeserializeOwned> Persistent<R> {
/// Sets the resource.
///
/// Changes are synchronized with the underlying storage immediately.
pub fn set(&mut self, new_resource: R) -> Result<(), PersistenceError> {
self.resource = Some(new_resource);
self.persist()
}
/// Updates the resource.
///
/// Changes are synchronized with the underlying storage immediately.
///
/// # Panics
///
/// Panics if the resource is unloaded.
pub fn update(&mut self, updater: impl Fn(&mut R)) -> Result<(), PersistenceError> {
if let Some(resource) = self.resource.as_mut() {
updater(resource);
self.persist()
} else {
panic!("tried to update unloaded {}", self.name);
}
}
/// Unloads the resource from memory.
///
/// Changes are synchronized with the underlying storage before unloading.
///
/// # Panics
///
/// Panics if the resource is unloaded.
pub fn unload(&mut self) -> Result<(), PersistenceError> {
if self.resource.is_some() {
self.persist().map_err(|error| {
log::error!(
"failed to unload {} due to not being able to persist it before unloading",
self.name,
);
error
})?;
self.resource = None;
log::info!("unloaded {}", self.name);
}
Ok(())
}
/// Unloads the resource from memory immediately.
///
/// Changes are **not** synchronized with the underlying storage before unloading.
pub fn unload_without_persisting(&mut self) {
if self.resource.is_some() {
self.resource = None;
log::info!("unloaded {} without persisting", self.name);
}
}
/// Reloads the resource from the underlying storage.
///
/// If reloading fails, the underlying resource is kept untouched.
pub fn reload(&mut self) -> Result<(), PersistenceError> {
match self.storage.read(&self.name, self.format) {
Ok(resource) => self.resource = Some(resource),
Err(error) => {
if !error.is_serde() {
log::error!("failed to reload {} from {}: {}", self.name, self.storage, error);
} else {
log::error!(
"failed to reload {} from {} due to a deserialization error",
self.storage,
self.name,
);
if self.revert_to_default_on_deserialization_errors {
log::info!(
"attempting to revert {} to default in {} automatically",
self.name,
self.storage,
);
if self.revert_to_default().is_err() {
// return the original deserialization error
return Err(error);
}
return Ok(());
}
}
return Err(error);
},
}
log::info!("reloaded {} from {}", self.name, self.storage);
Ok(())
}
/// 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(&mut self) -> Result<(), PersistenceError> {
if !self.is_revertible() {
panic!("tried to revert non-revertible {}", self.name);
}
self.storage
.write(&self.name, self.format, self.default.as_ref().unwrap())
.map(|_| {
log::info!("reverted {} to default in {}", self.name, self.storage);
})
.map_err(|error| {
// serialization errors are logged in format module
if !error.is_serde() {
log::error!(
"failed to revert {} to default in {}: {}",
self.name,
self.storage,
error,
);
} else {
log::error!(
"failed to revert {} to default in {} due to a serialization error",
self.name,
self.storage,
);
}
error
})?;
if self.is_loaded() {
self.revert_to_default_in_memory()?;
}
Ok(())
}
/// Reverts the resource to it's default value only in memory, not persistent storage.
///
/// # Panics
///
/// Panics if the resource is not revertible.
pub fn revert_to_default_in_memory(&mut self) -> Result<(), PersistenceError> {
if !self.is_revertible() {
panic!("tried to revert non-revertible {}", self.name);
}
// we need to make a copy of the default resource without using clone
// this is because cloning can have special semantics
// e.g., cloning Persistent<Arc<RwLock<R>>> and changing it
// would change the default object, which is not desired
let serialized =
self.format.serialize(&self.name, self.default.as_ref().unwrap()).map_err(|error| {
log::error!(
"failed to revert {} to default in memory due to a serialization error",
self.name,
);
error
})?;
let reconstructed = self.format.deserialize(&self.name, &serialized).map_err(|error| {
log::error!(
"failed to revert {} to default in memory due to a deserialization error",
self.name,
);
error
})?;
self.resource = Some(reconstructed);
log::info!("reverted {} to default in memory", self.name);
Ok(())
}
}
impl<R: Resource + Serialize + DeserializeOwned> Persistent<R> {
/// Writes the resource to the underlying storage.
///
/// # Panics
///
/// Panics if the resource is unloaded.
pub fn persist(&self) -> Result<(), PersistenceError> {
if let Some(resource) = &self.resource {
self.storage
.write(&self.name, self.format, resource)
.map(|_| {
log::info!("saved new {} to {}", self.name, self.storage);
})
.map_err(|error| {
// serialization errors are logged in format module
if !error.is_serde() {
log::error!(
"failed to save new {} to {}: {}",
self.name,
self.storage,
error,
);
} else {
log::error!(
"failed to save new {} to {} due to a serialization error",
self.name,
self.storage,
);
}
error
})
} else {
panic!("tried to save unloaded {}", self.name);
}
}
}
impl<R: Resource + Serialize + DeserializeOwned> Deref for Persistent<R> {
type Target = R;
fn deref(&self) -> &R {
self.get()
}
}
impl<R: Resource + Serialize + DeserializeOwned> DerefMut for Persistent<R> {
fn deref_mut(&mut self) -> &mut R {
self.get_mut()
}
}