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 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478
/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #![deny( missing_docs, non_camel_case_types, non_snake_case, path_statements, trivial_casts, trivial_numeric_casts, unsafe_code, unstable_features, unused_allocation, unused_import_braces, unused_imports, unused_must_use, unused_mut, while_true, clippy::panic, clippy::print_stdout, clippy::todo, //clippy::unwrap_used, // not yet in stable clippy::wrong_pub_self_convention )] #![warn(clippy::pedantic)] // part of `clippy::pedantic`, causing many warnings #![allow(clippy::missing_errors_doc, clippy::module_name_repetitions)] //! # Rustbreak //! //! Rustbreak was a [Daybreak][daybreak] inspired single file Database. //! It has now since evolved into something else. Please check v1 for a more //! similar version. //! //! You will find an overview here in the docs, but to give you a more complete //! tale of how this is used please check the [examples][examples]. //! //! At its core, Rustbreak is an attempt at making a configurable //! general-purpose store Database. It features the possibility of: //! //! - Choosing what kind of Data is stored in it //! - Which kind of Serialization is used for persistence //! - Which kind of persistence is used //! //! This means you can take any struct you can serialize and deserialize and //! stick it into this Database. It is then encoded with Ron, Yaml, JSON, //! Bincode, anything really that uses Serde operations! //! //! There are three helper type aliases [`MemoryDatabase`], [`FileDatabase`], //! and [`PathDatabase`], each backed by their respective backend. //! //! The [`MemoryBackend`] saves its data into a `Vec<u8>`, which is not that //! useful on its own, but is needed for compatibility with the rest of the //! Library. //! //! The [`FileDatabase`] is a classical file based database. You give it a path //! or a file, and it will use it as its storage. You still get to pick what //! encoding it uses. //! //! The [`PathDatabase`] is very similar, but always requires a path for //! creation. It features atomic saves, so that the old database contents won't //! be lost when panicing during the save. It should therefore be preferred to a //! [`FileDatabase`]. //! //! Using the [`Database::with_deser`] and [`Database::with_backend`] one can //! switch between the representations one needs. Even at runtime! However this //! is only useful in a few scenarios. //! //! If you have any questions feel free to ask at the main [repo][repo]. //! //! ## Quickstart //! //! Add this to your `Cargo.toml`: //! //! ```toml //! [dependencies.rustbreak] //! version = "2" //! features = ["ron_enc"] # You can also use "yaml_enc" or "bin_enc" //! # Check the documentation to add your own! //! ``` //! //! ```rust //! # extern crate rustbreak; //! # use std::collections::HashMap; //! use rustbreak::{deser::Ron, MemoryDatabase}; //! //! # fn main() { //! # let func = || -> Result<(), Box<dyn std::error::Error>> { //! let db = MemoryDatabase::<HashMap<u32, String>, Ron>::memory(HashMap::new())?; //! //! println!("Writing to Database"); //! db.write(|db| { //! db.insert(0, String::from("world")); //! db.insert(1, String::from("bar")); //! }); //! //! db.read(|db| { //! // db.insert("foo".into(), String::from("bar")); //! // The above line will not compile since we are only reading //! println!("Hello: {:?}", db.get(&0)); //! })?; //! # return Ok(()); }; //! # func().unwrap(); //! # } //! ``` //! //! Or alternatively: //! ```rust //! # extern crate rustbreak; //! # use std::collections::HashMap; //! use rustbreak::{deser::Ron, MemoryDatabase}; //! //! # fn main() { //! # let func = || -> Result<(), Box<dyn std::error::Error>> { //! let db = MemoryDatabase::<HashMap<u32, String>, Ron>::memory(HashMap::new())?; //! //! println!("Writing to Database"); //! { //! let mut data = db.borrow_data_mut()?; //! data.insert(0, String::from("world")); //! data.insert(1, String::from("bar")); //! } //! //! let data = db.borrow_data()?; //! println!("Hello: {:?}", data.get(&0)); //! # return Ok(()); }; //! # func().unwrap(); //! # } //! ``` //! //! ## Error Handling //! //! Handling errors in Rustbreak is straightforward. Every `Result` has as its //! fail case as [`error::RustbreakError`]. This means that you can now either //! continue bubbling up said error case, or handle it yourself. //! //! ```rust //! use rustbreak::{deser::Ron, error::RustbreakError, MemoryDatabase}; //! let db = match MemoryDatabase::<usize, Ron>::memory(0) { //! Ok(db) => db, //! Err(e) => { //! // Do something with `e` here //! std::process::exit(1); //! } //! }; //! ``` //! //! ## Panics //! //! This Database implementation uses [`RwLock`] and [`Mutex`] under the hood. //! If either the closures given to [`Database::write`] or any of the Backend //! implementation methods panic the respective objects are then poisoned. This //! means that you *cannot panic* under any circumstances in your closures or //! custom backends. //! //! Currently there is no way to recover from a poisoned `Database` other than //! re-creating it. //! //! ## Examples //! //! There are several more or less in-depth example programs you can check out! //! Check them out here: [Examples][examples] //! //! - `config.rs` shows you how a possible configuration file could be managed //! with rustbreak //! - `full.rs` shows you how the database can be used as a hashmap store //! - `switching.rs` show you how you can easily swap out different parts of the //! Database *Note*: To run this example you need to enable the feature `yaml` //! like so: `cargo run --example switching --features yaml` //! - `server/` is a fully fledged example app written with the Rocket framework //! to make a form of micro-blogging website. You will need rust nightly to //! start it. //! //! ## Features //! //! Rustbreak comes with following optional features: //! //! - `ron_enc` which enables the [Ron][ron] de/serialization //! - `yaml_enc` which enables the Yaml de/serialization //! - `bin_enc` which enables the Bincode de/serialization //! - 'mmap' whhich enables memory map backend. //! //! [Enable them in your `Cargo.toml` file to use them.][features] You can //! safely have them all turned on per-default. //! //! //! [repo]: https://github.com/TheNeikos/rustbreak //! [daybreak]: https://propublica.github.io/daybreak //! [examples]: https://github.com/TheNeikos/rustbreak/tree/master/examples //! [ron]: https://github.com/ron-rs/ron //! [features]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features pub mod backend; /// Different serialization and deserialization methods one can use pub mod deser; /// The rustbreak errors that can be returned pub mod error; /// The `DeSerializer` trait used by serialization structs pub use crate::deser::DeSerializer; /// The general error used by the Rustbreak Module use std::fmt::Debug; use std::ops::Deref; use std::path::PathBuf; use std::sync::{Mutex, RwLock, RwLockReadGuard, RwLockWriteGuard}; use serde::de::DeserializeOwned; use serde::Serialize; #[cfg(feature = "mmap")] use crate::backend::MmapStorage; use crate::backend::{Backend, FileBackend, MemoryBackend, PathBackend}; pub use crate::error::*; /// The Central Database to Rustbreak. /// /// It has 3 Type Generics: /// /// - `Data`: Is the Data, you must specify this /// - `Back`: The storage backend. /// - `DeSer`: The Serializer/Deserializer or short `DeSer`. Check the [`deser`] /// module for other strategies. /// /// # Panics /// /// If the backend or the de/serialization panics, the database is poisoned. /// This means that any subsequent writes/reads will fail with an /// [`error::RustbreakError::Poison`]. You can only recover from this by /// re-creating the Database Object. #[derive(Debug)] pub struct Database<Data, Back, DeSer> { data: RwLock<Data>, backend: Mutex<Back>, deser: DeSer, } impl<Data, Back, DeSer> Database<Data, Back, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send, Back: Backend, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Write lock the database and get write access to the `Data` container. /// /// This gives you an exclusive lock on the memory object. Trying to open /// the database in writing will block if it is currently being written /// to. /// /// # Panics /// /// If you panic in the closure, the database is poisoned. This means that /// any subsequent writes/reads will fail with an /// [`error::RustbreakError::Poison`]. You can only recover from /// this by re-creating the Database Object. /// /// If you do not have full control over the code being written, and cannot /// incur the cost of having a single operation panicking then use /// [`Database::write_safe`]. /// /// # Examples /// /// ```rust /// # #[macro_use] extern crate serde_derive; /// # extern crate rustbreak; /// # extern crate serde; /// # extern crate tempfile; /// use rustbreak::{deser::Ron, FileDatabase}; /// /// #[derive(Debug, Serialize, Deserialize, Clone)] /// struct Data { /// level: u32, /// } /// /// # fn main() { /// # let func = || -> Result<(), Box<dyn std::error::Error>> { /// # let file = tempfile::tempfile()?; /// let db = FileDatabase::<Data, Ron>::from_file(file, Data { level: 0 })?; /// /// db.write(|db| { /// db.level = 42; /// })?; /// /// // You can also return from a `.read()`. But don't forget that you cannot return references /// // into the structure /// let value = db.read(|db| db.level)?; /// assert_eq!(42, value); /// # return Ok(()); /// # }; /// # func().unwrap(); /// # } /// ``` pub fn write<T, R>(&self, task: T) -> error::Result<R> where T: FnOnce(&mut Data) -> R, { let mut lock = self.data.write().map_err(|_| RustbreakError::Poison)?; Ok(task(&mut lock)) } /// Write lock the database and get write access to the `Data` container in /// a safe way. /// /// This gives you an exclusive lock on the memory object. Trying to open /// the database in writing will block if it is currently being written /// to. /// /// This differs to `Database::write` in that a clone of the internal data /// is made, which is then passed to the closure. Only if the closure /// doesn't panic is the internal model updated. /// /// Depending on the size of the database this can be very costly. This is a /// tradeoff to make for panic safety. /// /// You should read the documentation about this: /// [`UnwindSafe`](https://doc.rust-lang.org/std/panic/trait.UnwindSafe.html) /// /// # Panics /// /// When the closure panics, it is caught and a /// [`error::RustbreakError::WritePanic`] will be returned. /// /// # Examples /// /// ```rust /// # #[macro_use] extern crate serde_derive; /// # extern crate rustbreak; /// # extern crate serde; /// # extern crate tempfile; /// use rustbreak::{ /// deser::Ron, /// error::RustbreakError, /// FileDatabase, /// }; /// /// #[derive(Debug, Serialize, Deserialize, Clone)] /// struct Data { /// level: u32, /// } /// /// # fn main() { /// # let func = || -> Result<(), Box<dyn std::error::Error>> { /// # let file = tempfile::tempfile()?; /// let db = FileDatabase::<Data, Ron>::from_file(file, Data { level: 0 })?; /// /// let result = db /// .write_safe(|db| { /// db.level = 42; /// panic!("We panic inside the write code."); /// }) /// .expect_err("This should have been caught"); /// /// match result { /// RustbreakError::WritePanic => { /// // We can now handle this, in this example we will just ignore it /// } /// e => { /// println!("{:#?}", e); /// // You should always have generic error catching here. /// // This future-proofs your code, and makes your code more robust. /// // In this example this is unreachable though, and to assert that we have this /// // macro here /// unreachable!(); /// } /// } /// /// // We read it back out again, it has not changed /// let value = db.read(|db| db.level)?; /// assert_eq!(0, value); /// # return Ok(()); /// # }; /// # func().unwrap(); /// # } /// ``` pub fn write_safe<T>(&self, task: T) -> error::Result<()> where T: FnOnce(&mut Data) + std::panic::UnwindSafe, { let mut lock = self.data.write().map_err(|_| RustbreakError::Poison)?; let mut data = lock.clone(); std::panic::catch_unwind(::std::panic::AssertUnwindSafe(|| { task(&mut data); })) .map_err(|_| RustbreakError::WritePanic)?; *lock = data; Ok(()) } /// Read lock the database and get read access to the `Data` container. /// /// This gives you a read-only lock on the database. You can have as many /// readers in parallel as you wish. /// /// # Errors /// /// May return: /// /// - [`error::RustbreakError::Backend`] /// /// # Panics /// /// If you panic in the closure, the database is poisoned. This means that /// any subsequent writes/reads will fail with an /// [`error::RustbreakError::Poison`]. You can only recover from /// this by re-creating the Database Object. pub fn read<T, R>(&self, task: T) -> error::Result<R> where T: FnOnce(&Data) -> R, { let mut lock = self.data.read().map_err(|_| RustbreakError::Poison)?; Ok(task(&mut lock)) } /// Read lock the database and get access to the underlying struct. /// /// This gives you access to the underlying struct, allowing for simple read /// only operations on it. /// /// # Examples /// /// ```rust /// # #[macro_use] extern crate serde_derive; /// # extern crate rustbreak; /// # extern crate serde; /// # extern crate tempfile; /// use rustbreak::{deser::Ron, FileDatabase}; /// /// #[derive(Debug, Serialize, Deserialize, Clone)] /// struct Data { /// level: u32, /// } /// /// # fn main() { /// # let func = || -> Result<(), Box<dyn std::error::Error>> { /// # let file = tempfile::tempfile()?; /// let db = FileDatabase::<Data, Ron>::from_file(file, Data { level: 0 })?; /// /// db.write(|db| { /// db.level = 42; /// })?; /// /// let data = db.borrow_data()?; /// /// assert_eq!(42, data.level); /// # return Ok(()); /// # }; /// # func().unwrap(); /// # } /// ``` pub fn borrow_data<'a>(&'a self) -> error::Result<RwLockReadGuard<'a, Data>> { self.data.read().map_err(|_| RustbreakError::Poison) } /// Write lock the database and get access to the underlying struct. /// /// This gives you access to the underlying struct, allowing you to modify /// it. /// /// # Panics /// /// If you panic while holding this reference, the database is poisoned. /// This means that any subsequent writes/reads will fail with an /// [`error::RustbreakError::Poison`]. You can only recover from /// this by re-creating the Database Object. /// /// If you do not have full control over the code being written, and cannot /// incur the cost of having a single operation panicking then use /// [`Database::write_safe`]. /// /// # Examples /// /// ```rust /// # #[macro_use] extern crate serde_derive; /// # extern crate rustbreak; /// # extern crate serde; /// # extern crate tempfile; /// use rustbreak::{deser::Ron, FileDatabase}; /// /// #[derive(Debug, Serialize, Deserialize, Clone)] /// struct Data { /// level: u32, /// } /// /// # fn main() { /// # let func = || -> Result<(), Box<dyn std::error::Error>> { /// # let file = tempfile::tempfile()?; /// let db = FileDatabase::<Data, Ron>::from_file(file, Data { level: 0 })?; /// /// { /// let mut data = db.borrow_data_mut()?; /// data.level = 42; /// } /// /// let data = db.borrow_data()?; /// /// assert_eq!(42, data.level); /// # return Ok(()); /// # }; /// # func().unwrap(); /// # } /// ``` pub fn borrow_data_mut<'a>(&'a self) -> error::Result<RwLockWriteGuard<'a, Data>> { self.data.write().map_err(|_| RustbreakError::Poison) } /// Load data from backend and return this data. fn load_from_backend(backend: &mut Back, deser: &DeSer) -> error::Result<Data> { let new_data = deser.deserialize(&backend.get_data()?[..])?; Ok(new_data) } /// Like [`Self::load`] but returns the write lock to data it used. fn load_get_data_lock(&self) -> error::Result<RwLockWriteGuard<'_, Data>> { let mut backend_lock = self.backend.lock().map_err(|_| RustbreakError::Poison)?; let fresh_data = Self::load_from_backend(&mut backend_lock, &self.deser)?; drop(backend_lock); let mut data_write_lock = self.data.write().map_err(|_| RustbreakError::Poison)?; *data_write_lock = fresh_data; Ok(data_write_lock) } /// Load the data from the backend. pub fn load(&self) -> error::Result<()> { self.load_get_data_lock().map(|_| ()) } /// Like [`Self::save`] but with explicit read (or write) lock to data. fn save_data_locked<L: Deref<Target = Data>>(&self, lock: L) -> error::Result<()> { let ser = self.deser.serialize(lock.deref())?; drop(lock); let mut backend = self.backend.lock().map_err(|_| RustbreakError::Poison)?; backend.put_data(&ser)?; Ok(()) } /// Flush the data structure to the backend. pub fn save(&self) -> error::Result<()> { let data = self.data.read().map_err(|_| RustbreakError::Poison)?; self.save_data_locked(data) } /// Get a clone of the data as it is in memory right now. /// /// To make sure you have the latest data, call this method with `load` /// true. pub fn get_data(&self, load: bool) -> error::Result<Data> { let data = if load { self.load_get_data_lock()? } else { self.data.write().map_err(|_| RustbreakError::Poison)? }; Ok(data.clone()) } /// Puts the data as is into memory. /// /// To save the data afterwards, call with `save` true. pub fn put_data(&self, new_data: Data, save: bool) -> error::Result<()> { let mut data = self.data.write().map_err(|_| RustbreakError::Poison)?; *data = new_data; if save { self.save_data_locked(data) } else { Ok(()) } } /// Create a database from its constituents. pub fn from_parts(data: Data, backend: Back, deser: DeSer) -> Self { Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, } } /// Break a database into its individual parts. pub fn into_inner(self) -> error::Result<(Data, Back, DeSer)> { Ok(( self.data.into_inner().map_err(|_| RustbreakError::Poison)?, self.backend .into_inner() .map_err(|_| RustbreakError::Poison)?, self.deser, )) } /// Tries to clone the Data in the Database. /// /// This method returns a `MemoryDatabase` which has an empty vector as a /// backend initially. This means that the user is responsible for assigning /// a new backend if an alternative is wanted. /// /// # Examples /// /// ```rust /// # #[macro_use] extern crate serde_derive; /// # extern crate rustbreak; /// # extern crate serde; /// # extern crate tempfile; /// use rustbreak::{deser::Ron, FileDatabase}; /// /// #[derive(Debug, Serialize, Deserialize, Clone)] /// struct Data { /// level: u32, /// } /// /// # fn main() { /// # let func = || -> Result<(), Box<dyn std::error::Error>> { /// # let file = tempfile::tempfile()?; /// let db = FileDatabase::<Data, Ron>::from_file(file, Data { level: 0 })?; /// /// db.write(|db| { /// db.level = 42; /// })?; /// /// db.save()?; /// /// let other_db = db.try_clone()?; /// /// // You can also return from a `.read()`. But don't forget that you cannot return references /// // into the structure /// let value = other_db.read(|db| db.level)?; /// assert_eq!(42, value); /// # return Ok(()); /// # }; /// # func().unwrap(); /// # } /// ``` pub fn try_clone(&self) -> error::Result<MemoryDatabase<Data, DeSer>> { let lock = self.data.read().map_err(|_| RustbreakError::Poison)?; Ok(Database { data: RwLock::new(lock.clone()), backend: Mutex::new(MemoryBackend::new()), deser: self.deser.clone(), }) } } /// A database backed by a file. pub type FileDatabase<D, DS> = Database<D, FileBackend, DS>; impl<Data, DeSer> Database<Data, FileBackend, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Create new [`FileDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. pub fn load_from_path<S>(path: S) -> error::Result<Self> where S: AsRef<std::path::Path>, { let mut backend = FileBackend::from_path_or_fail(path)?; let deser = DeSer::default(); let data = Self::load_from_backend(&mut backend, &deser)?; let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; Ok(db) } /// Load [`FileDatabase`] at `path` or initialise with `data`. /// /// Create new [`FileDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. If the file does not exist, initialise with /// `data`. pub fn load_from_path_or<S>(path: S, data: Data) -> error::Result<Self> where S: AsRef<std::path::Path>, { let (mut backend, exists) = FileBackend::from_path_or_create(path)?; let deser = DeSer::default(); if !exists { let ser = deser.serialize(&data)?; backend.put_data(&ser)?; } let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; if exists { db.load()?; } Ok(db) } /// Load [`FileDatabase`] at `path` or initialise with `closure`. /// /// Create new [`FileDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. If the file does not exist, `closure` is /// called and the database is initialised with it's return value. pub fn load_from_path_or_else<S, C>(path: S, closure: C) -> error::Result<Self> where S: AsRef<std::path::Path>, C: FnOnce() -> Data, { let (mut backend, exists) = FileBackend::from_path_or_create(path)?; let deser = DeSer::default(); let data = if exists { Self::load_from_backend(&mut backend, &deser)? } else { let data = closure(); let ser = deser.serialize(&data)?; backend.put_data(&ser)?; data }; let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; Ok(db) } /// Create [`FileDatabase`] at `path`. Initialise with `data` if the file /// doesn't exist. /// /// Create new [`FileDatabase`] from the file at [`Path`](std::path::Path). /// Contents are not loaded. If the file does not exist, it is /// initialised with `data`. Frontend is always initialised with `data`. pub fn create_at_path<S>(path: S, data: Data) -> error::Result<Self> where S: AsRef<std::path::Path>, { let (mut backend, exists) = FileBackend::from_path_or_create(path)?; let deser = DeSer::default(); if !exists { let ser = deser.serialize(&data)?; backend.put_data(&ser)?; } let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; Ok(db) } /// Create new [`FileDatabase`] from a file. pub fn from_file(file: std::fs::File, data: Data) -> error::Result<Self> { let backend = FileBackend::from_file(file); Ok(Self { data: RwLock::new(data), backend: Mutex::new(backend), deser: DeSer::default(), }) } } impl<Data, DeSer> Database<Data, FileBackend, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send + Default, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Load [`FileDatabase`] at `path` or initialise with `Data::default()`. /// /// Create new [`FileDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. If the file does not exist, initialise with /// `Data::default`. pub fn load_from_path_or_default<S>(path: S) -> error::Result<Self> where S: AsRef<std::path::Path>, { Self::load_from_path_or_else(path, Data::default) } } /// A database backed by a file, using atomic saves. pub type PathDatabase<D, DS> = Database<D, PathBackend, DS>; impl<Data, DeSer> Database<Data, PathBackend, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Create new [`PathDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. pub fn load_from_path(path: PathBuf) -> error::Result<Self> { let mut backend = PathBackend::from_path_or_fail(path)?; let deser = DeSer::default(); let data = Self::load_from_backend(&mut backend, &deser)?; let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; Ok(db) } /// Load [`PathDatabase`] at `path` or initialise with `data`. /// /// Create new [`PathDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. If the file does not exist, initialise with /// `data`. pub fn load_from_path_or(path: PathBuf, data: Data) -> error::Result<Self> { let (mut backend, exists) = PathBackend::from_path_or_create(path)?; let deser = DeSer::default(); if !exists { let ser = deser.serialize(&data)?; backend.put_data(&ser)?; } let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; if exists { db.load()?; } Ok(db) } /// Load [`PathDatabase`] at `path` or initialise with `closure`. /// /// Create new [`PathDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. If the file does not exist, `closure` is /// called and the database is initialised with it's return value. pub fn load_from_path_or_else<C>(path: PathBuf, closure: C) -> error::Result<Self> where C: FnOnce() -> Data, { let (mut backend, exists) = PathBackend::from_path_or_create(path)?; let deser = DeSer::default(); let data = if exists { Self::load_from_backend(&mut backend, &deser)? } else { let data = closure(); let ser = deser.serialize(&data)?; backend.put_data(&ser)?; data }; let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; Ok(db) } /// Create [`PathDatabase`] at `path`. Initialise with `data` if the file /// doesn't exist. /// /// Create new [`PathDatabase`] from the file at [`Path`](std::path::Path). /// Contents are not loaded. If the file does not exist, it is /// initialised with `data`. Frontend is always initialised with `data`. pub fn create_at_path(path: PathBuf, data: Data) -> error::Result<Self> { let (mut backend, exists) = PathBackend::from_path_or_create(path)?; let deser = DeSer::default(); if !exists { let ser = deser.serialize(&data)?; backend.put_data(&ser)?; } let db = Self { data: RwLock::new(data), backend: Mutex::new(backend), deser, }; Ok(db) } } impl<Data, DeSer> Database<Data, PathBackend, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send + Default, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Load [`PathDatabase`] at `path` or initialise with `Data::default()`. /// /// Create new [`PathDatabase`] from the file at [`Path`](std::path::Path), /// and load the contents. If the file does not exist, initialise with /// `Data::default`. pub fn load_from_path_or_default(path: PathBuf) -> error::Result<Self> { Self::load_from_path_or_else(path, Data::default) } } /// A database backed by a byte vector (`Vec<u8>`). pub type MemoryDatabase<D, DS> = Database<D, MemoryBackend, DS>; impl<Data, DeSer> Database<Data, MemoryBackend, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Create new in-memory database. pub fn memory(data: Data) -> error::Result<Self> { let backend = MemoryBackend::new(); Ok(Self { data: RwLock::new(data), backend: Mutex::new(backend), deser: DeSer::default(), }) } } /// A database backed by anonymous memory map. #[cfg(feature = "mmap")] pub type MmapDatabase<D, DS> = Database<D, MmapStorage, DS>; #[cfg(feature = "mmap")] impl<Data, DeSer> Database<Data, MmapStorage, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Create new [`MmapDatabase`]. pub fn mmap(data: Data) -> error::Result<Self> { let backend = MmapStorage::new()?; Ok(Self { data: RwLock::new(data), backend: Mutex::new(backend), deser: DeSer::default(), }) } /// Create new [`MmapDatabase`] with specified initial size. pub fn mmap_with_size(data: Data, size: usize) -> error::Result<Self> { let backend = MmapStorage::with_size(size)?; Ok(Self { data: RwLock::new(data), backend: Mutex::new(backend), deser: DeSer::default(), }) } } impl<Data, Back, DeSer> Database<Data, Back, DeSer> { /// Exchanges the `DeSerialization` strategy with the new one. pub fn with_deser<T>(self, deser: T) -> Database<Data, Back, T> { Database { backend: self.backend, data: self.data, deser, } } } impl<Data, Back, DeSer> Database<Data, Back, DeSer> { /// Exchanges the `Backend` with the new one. /// /// The new backend does not necessarily have the latest data saved to it, /// so a `.save` should be called to make sure that it is saved. pub fn with_backend<T>(self, backend: T) -> Database<Data, T, DeSer> { Database { backend: Mutex::new(backend), data: self.data, deser: self.deser, } } } impl<Data, Back, DeSer> Database<Data, Back, DeSer> where Data: Serialize + DeserializeOwned + Clone + Send, Back: Backend, DeSer: DeSerializer<Data> + Send + Sync + Clone, { /// Converts from one data type to another. /// /// This method is useful to migrate from one datatype to another. pub fn convert_data<C, OutputData>( self, convert: C, ) -> error::Result<Database<OutputData, Back, DeSer>> where OutputData: Serialize + DeserializeOwned + Clone + Send, C: FnOnce(Data) -> OutputData, DeSer: DeSerializer<OutputData> + Send + Sync, { let (data, backend, deser) = self.into_inner()?; Ok(Database { data: RwLock::new(convert(data)), backend: Mutex::new(backend), deser, }) } } #[cfg(test)] mod tests { use super::*; use std::collections::HashMap; use tempfile::NamedTempFile; type TestData = HashMap<usize, String>; type TestDb<B> = Database<TestData, B, crate::deser::Ron>; type TestMemDb = TestDb<MemoryBackend>; fn test_data() -> TestData { let mut data = HashMap::new(); data.insert(1, "Hello World".to_string()); data.insert(100, "Rustbreak".to_string()); data } /// Used to test that `Default::default` isn't called. #[derive(Clone, Debug, Serialize, serde::Deserialize)] struct PanicDefault; impl Default for PanicDefault { fn default() -> Self { panic!("`default` was called but should not") } } #[test] fn create_db_and_read() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); } #[test] fn write_twice() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); db.write(|d| d.insert(3, "Write to db".to_string())) .expect("Rustbreak write error"); db.write(|d| d.insert(3, "Second write".to_string())) .expect("Rustbreak write error"); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Second write", db.read(|d| d.get(&3).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); } #[test] fn save_load() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); db.save().expect("Rustbreak save error"); db.write(|d| d.clear()).expect("Rustbreak write error"); db.load().expect("Rustbreak load error"); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); } #[test] fn writesafe_twice() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); db.write_safe(|d| { d.insert(3, "Write to db".to_string()); }) .expect("Rustbreak write error"); db.write_safe(|d| { d.insert(3, "Second write".to_string()); }) .expect("Rustbreak write error"); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Second write", db.read(|d| d.get(&3).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); } #[test] fn writesafe_panic() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); let err = db .write_safe(|d| { d.clear(); panic!("Panic should be catched") }) .expect_err("Did not error on panic in safe write!"); assert!(matches!(err, RustbreakError::WritePanic)); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); } #[test] fn borrow_data_twice() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); let readlock1 = db.borrow_data().expect("Rustbreak readlock error"); let readlock2 = db.borrow_data().expect("Rustbreak readlock error"); assert_eq!( "Hello World", readlock1.get(&1).expect("Should be `Some` but was `None`") ); assert_eq!( "Hello World", readlock2.get(&1).expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", readlock1 .get(&100) .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", readlock2 .get(&100) .expect("Should be `Some` but was `None`") ); assert_eq!(*readlock1, *readlock2); } #[test] fn borrow_data_mut() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); let mut writelock = db.borrow_data_mut().expect("Rustbreak writelock error"); writelock.insert(3, "Write to db".to_string()); drop(writelock); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Write to db", db.read(|d| d.get(&3).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); } #[test] fn get_data_mem() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); let data = db.get_data(false).expect("could not get data"); assert_eq!(test_data(), data); } #[test] fn get_data_load() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); db.save().expect("Rustbreak save error"); db.write(|d| d.clear()).expect("Rustbreak write error"); let data = db.get_data(true).expect("could not get data"); assert_eq!(test_data(), data); } #[test] fn put_data_mem() { let db = TestMemDb::memory(TestData::default()).expect("Could not create database"); db.put_data(test_data(), false).expect("could not put data"); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); let data = db.get_data(false).expect("could not get data"); assert_eq!(test_data(), data); } #[test] fn put_data_save() { let db = TestMemDb::memory(TestData::default()).expect("Could not create database"); db.put_data(test_data(), true).expect("could not put data"); db.load().expect("Rustbreak load error"); assert_eq!( "Hello World", db.read(|d| d.get(&1).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); assert_eq!( "Rustbreak", db.read(|d| d.get(&100).cloned()) .expect("Rustbreak read error") .expect("Should be `Some` but was `None`") ); let data = db.get_data(false).expect("could not get data"); assert_eq!(test_data(), data); } #[test] fn save_and_into_inner() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); db.save().expect("Rustbreak save error"); let (data, mut backend, _) = db .into_inner() .expect("error calling `Database.into_inner`"); assert_eq!(test_data(), data); let parsed: TestData = ron::de::from_reader(&backend.get_data().expect("could not get data from backend")[..]) .expect("backend contains invalid RON"); assert_eq!(test_data(), parsed); } #[test] fn clone() { let db1 = TestMemDb::memory(test_data()).expect("Could not create database"); let readlock1 = db1.borrow_data().expect("Rustbreak readlock error"); let db2 = db1.try_clone().expect("Rustbreak clone error"); let readlock2 = db2.borrow_data().expect("Rustbreak readlock error"); assert_eq!(test_data(), *readlock1); assert_eq!(*readlock1, *readlock2); } #[test] fn allow_databases_with_boxed_backend() { let db = MemoryDatabase::<Vec<u64>, crate::deser::Ron>::memory(vec![]).expect("To be created"); let db: Database<_, Box<dyn Backend>, _> = db.with_backend(Box::new(MemoryBackend::new())); db.put_data(vec![1, 2, 3], true) .expect("Can save data in memory"); assert_eq!( &[1, 2, 3], &db.get_data(true).expect("Can get data from memory")[..] ); } /// Since `save` only needs read-access to the data we should be able to /// save while holding a readlock. #[test] fn save_holding_readlock() { let db = TestMemDb::memory(test_data()).expect("Could not create database"); let readlock = db.borrow_data().expect("Rustbreak readlock error"); db.save().expect("Rustbreak save error"); assert_eq!(test_data(), *readlock); } /// Test that if the file already exists, the closure won't be called. #[test] #[cfg_attr(miri, ignore)] fn pathdb_from_path_or_else_existing_nocall() { let file = NamedTempFile::new().expect("could not create temporary file"); let path = file.path().to_owned(); let _ = TestDb::<PathBackend>::load_from_path_or_else(path, || { panic!("closure called while file existed") }); } /// Test that if the file already exists, the closure won't be called. #[test] #[cfg_attr(miri, ignore)] fn filedb_from_path_or_else_existing_nocall() { let file = NamedTempFile::new().expect("could not create temporary file"); let path = file.path(); let _ = TestDb::<FileBackend>::load_from_path_or_else(path, || { panic!("closure called while file existed") }); } /// Test that if the file already exists, `default` won't be called. #[test] #[cfg_attr(miri, ignore)] fn pathdb_from_path_or_default_existing_nocall() { let file = NamedTempFile::new().expect("could not create temporary file"); let path = file.path().to_owned(); let _ = Database::<PanicDefault, PathBackend, crate::deser::Ron>::load_from_path_or_default( path, ); } /// Test that if the file already exists, the closure won't be called. #[test] #[cfg_attr(miri, ignore)] fn filedb_from_path_or_default_existing_nocall() { let file = NamedTempFile::new().expect("could not create temporary file"); let path = file.path(); let _ = Database::<PanicDefault, FileBackend, crate::deser::Ron>::load_from_path_or_default( path, ); } #[test] #[cfg_attr(miri, ignore)] fn pathdb_from_path_or_new() { let dir = tempfile::tempdir().expect("could not create temporary directory"); let mut file_path = dir.path().to_owned(); file_path.push("rustbreak_path_db.db"); let db = TestDb::<PathBackend>::load_from_path_or(file_path, test_data()) .expect("could not load from path"); db.load().expect("could not load"); let readlock = db.borrow_data().expect("Rustbreak readlock error"); assert_eq!(test_data(), *readlock); dir.close().expect("Error while deleting temp directory!"); } #[test] #[cfg_attr(miri, ignore)] fn pathdb_from_path_or_else_new() { let dir = tempfile::tempdir().expect("could not create temporary directory"); let mut file_path = dir.path().to_owned(); file_path.push("rustbreak_path_db.db"); let db = TestDb::<PathBackend>::load_from_path_or_else(file_path, test_data) .expect("could not load from path"); db.load().expect("could not load"); let readlock = db.borrow_data().expect("Rustbreak readlock error"); assert_eq!(test_data(), *readlock); dir.close().expect("Error while deleting temp directory!"); } #[test] #[cfg_attr(miri, ignore)] fn filedb_from_path_or_new() { let dir = tempfile::tempdir().expect("could not create temporary directory"); let mut file_path = dir.path().to_owned(); file_path.push("rustbreak_path_db.db"); let db = TestDb::<FileBackend>::load_from_path_or(file_path, test_data()) .expect("could not load from path"); db.load().expect("could not load"); let readlock = db.borrow_data().expect("Rustbreak readlock error"); assert_eq!(test_data(), *readlock); dir.close().expect("Error while deleting temp directory!"); } #[test] #[cfg_attr(miri, ignore)] fn filedb_from_path_or_else_new() { let dir = tempfile::tempdir().expect("could not create temporary directory"); let mut file_path = dir.path().to_owned(); file_path.push("rustbreak_path_db.db"); let db = TestDb::<FileBackend>::load_from_path_or_else(file_path, test_data) .expect("could not load from path"); db.load().expect("could not load"); let readlock = db.borrow_data().expect("Rustbreak readlock error"); assert_eq!(test_data(), *readlock); dir.close().expect("Error while deleting temp directory!"); } #[test] #[cfg_attr(miri, ignore)] fn pathdb_from_path_new_fail() { let dir = tempfile::tempdir().expect("could not create temporary directory"); let mut file_path = dir.path().to_owned(); file_path.push("rustbreak_path_db.db"); let err = TestDb::<PathBackend>::load_from_path(file_path) .expect_err("should fail with file not found"); if let RustbreakError::Backend(BackendError::Io(io_err)) = &err { assert_eq!(std::io::ErrorKind::NotFound, io_err.kind()); } else { panic!("Wrong error: {}", err) }; dir.close().expect("Error while deleting temp directory!"); } #[test] #[cfg_attr(miri, ignore)] fn filedb_from_path_new_fail() { let dir = tempfile::tempdir().expect("could not create temporary directory"); let mut file_path = dir.path().to_owned(); file_path.push("rustbreak_path_db.db"); let err = TestDb::<FileBackend>::load_from_path(file_path) .expect_err("should fail with file not found"); if let RustbreakError::Backend(BackendError::Io(io_err)) = &err { assert_eq!(std::io::ErrorKind::NotFound, io_err.kind()); } else { panic!("Wrong error: {}", err) }; dir.close().expect("Error while deleting temp directory!"); } #[test] #[cfg_attr(miri, ignore)] fn pathdb_from_path_existing() { let file = NamedTempFile::new().expect("could not create temporary file"); let path = file.path().to_owned(); // initialise the file let db = TestDb::<PathBackend>::create_at_path(path.clone(), test_data()) .expect("could not create db"); db.save().expect("could not save db"); drop(db); // test that loading now works let db = TestDb::<PathBackend>::load_from_path(path).expect("could not load"); let readlock = db.borrow_data().expect("Rustbreak readlock error"); assert_eq!(test_data(), *readlock); } #[test] #[cfg_attr(miri, ignore)] fn filedb_from_path_existing() { let file = NamedTempFile::new().expect("could not create temporary file"); let path = file.path(); // initialise the file let db = TestDb::<FileBackend>::create_at_path(path, test_data()).expect("could not create db"); db.save().expect("could not save db"); drop(db); // test that loading now works let db = TestDb::<FileBackend>::load_from_path(path).expect("could not load"); let readlock = db.borrow_data().expect("Rustbreak readlock error"); assert_eq!(test_data(), *readlock); } }