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
use std::collections::HashMap; use std::fs::OpenOptions; use std::io::prelude::*; extern crate fs2; use engine::fs2::FileExt; use std::io; use file_services; const OBFUSCATE: bool = false; #[derive(Debug)] pub struct RecordCharacteristics { pub record_id: usize, pub chksum: u32, pub datatype: u8, pub location: usize, pub size: usize, pub record: String, pub key: String, // pub obfuscated: u32, will be added in ver 3:0, breaking change in code. // pub encryption_key: String, will be added in ver 3:0, breaking change in code. } #[derive(Debug)] pub enum MyOutput { StringType(String), F64Type(f64), U64Type(u64), I64Type(i64), F32Type(f32), U32Type(u32), I32Type(i32), } ///This is enum helps categorise the type of data that is being stored. It will be used to convert the data ///back to its orignal type (this will be fully implimented in the next release). pub enum DataType { Empty, StringType, F64Type, U64Type, I64Type, F32Type, U32Type, I32Type, } ///This function converts the DataType enum to a numeric u8 value suitable for storage in the database. pub fn data_type(datatype: &DataType) -> u8 { match *datatype { DataType::Empty => 0, DataType::StringType => 1, DataType::F64Type => 2, DataType::U64Type => 3, DataType::I64Type => 4, DataType::F32Type => 5, DataType::U32Type => 6, DataType::I32Type => 7, } } pub trait Base { fn addb(self) -> (DataType, String); } //#[derive(Clone, Copy)] pub struct DataLink<T: Base> { pub what_to_add: T, } #[derive(Debug)] pub struct RecordData { pub location: usize, pub location_type: u8, pub hash_data: HashMap<usize, RecordCharacteristics>, pub record_counter: usize, pub data_base: String, } pub struct RecordDataReadOnly { pub location: usize, pub location_type: u8, pub hash_data: HashMap<usize, RecordCharacteristics>, pub record_counter: usize, pub data_base: String, } /// Saves a database to a file. If the OBFUSCATE const is set to true, the data is "obfuscated" /// (meaning the data is not encrypted but rather just slightly hidden). /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let database = load_hash_database("test1base.txt"); /// database.save_database("test1base.txt"); /// /// ``` pub fn save_hash_database(filename: &str, hash_to_save: &HashMap<usize, RecordCharacteristics>) -> io::Result<usize> { let mut file = OpenOptions::new() .write(true) .create(true) .truncate(true) .open(filename) .unwrap(); let mut cache_write_hold = "".to_string(); for individual_record_information in hash_to_save { cache_write_hold = cache_write_hold + &individual_record_information.0.to_string() + "~$" + &individual_record_information.1.record_id.to_string() + "~$" + &individual_record_information.1.chksum.to_string() + "~$" + &individual_record_information.1.datatype.to_string() + "~$" + &individual_record_information.1.location.to_string() + "~$" + &individual_record_information.1.size.to_string() + "~$" + &individual_record_information.1.record + "~$" + &individual_record_information.1.key + "~$"; } if !OBFUSCATE { file.lock_exclusive()?; file.write_all(cache_write_hold.as_bytes()).unwrap(); file.unlock()?; return Ok(0); } else { file.lock_exclusive()?; file.write_all(obfuscate_data(cache_write_hold).as_bytes()) .unwrap(); file.unlock()?; return Ok(0); } } /// This function produces a basic chksum for a Vector of u8 bytes. It is not for security purposes but /// rather data validation only. /// /// # Examples /// /// ``` /// let result = simplebase::engine::chksum(&"This is a test".as_bytes()); /// assert_eq!(1269,result); /// /// ``` pub fn chksum(data: &[u8]) -> u32 { let mut chksum = 0 as u32; for i in data.iter() { chksum += u32::from(*i); } chksum } /// This loads a file that was saved using the "save_database" as read only (only read functions such as searching etc are permitted) /// function which can then be used with the appropriate methods. /// /// # Examples /// /// ``` /// /// let loaded_hash_read_ony = simplebase::engine::load_hash_database_read_only("test1base.txt"); /// /// ``` /// # Panics /// If the file does not exist then this function will panic!() pub fn load_hash_database_read_only(database_name: &str) -> RecordDataReadOnly { let mut loaded_hash: HashMap<usize, RecordCharacteristics> = HashMap::new(); let raw_hash_file = file_services::open_file(&database_name).unwrap(); let mut raw_hash_file = String::from_utf8_lossy(&raw_hash_file) .to_owned() .to_string(); if OBFUSCATE { raw_hash_file = obfuscate_data(raw_hash_file.to_string()); } let pre_translated_hash_data: Vec<&str> = raw_hash_file.split("~$").collect(); let mut counter = 0; while counter < pre_translated_hash_data.len() - 1 { let mut database_hold = RecordCharacteristics { record_id: 0, chksum: 0, datatype: 0, location: 0, size: 0, record: "NULL".to_string(), key: "".to_string(), }; database_hold.record_id = pre_translated_hash_data[counter + 1] .parse::<usize>() .unwrap(); database_hold.chksum = pre_translated_hash_data[counter + 2] .parse::<u32>() .unwrap(); database_hold.datatype = pre_translated_hash_data[counter + 3].parse::<u8>().unwrap(); database_hold.location = pre_translated_hash_data[counter + 4] .parse::<usize>() .unwrap(); database_hold.size = pre_translated_hash_data[counter + 5] .parse::<usize>() .unwrap(); database_hold.record = pre_translated_hash_data[counter + 6].to_string(); database_hold.key = pre_translated_hash_data[counter + 7].to_string(); loaded_hash.insert( pre_translated_hash_data[counter].parse::<usize>().unwrap(), database_hold, ); counter += 8; } let mut record_counter2 = 0; // match loaded_hash.get(&0) { // Some(first_record) => record_counter2 = first_record.record_id, //this is a special value for the first record // None => (), // } if let Some(first_record) = loaded_hash.get(&0) { record_counter2 = first_record.record_id }; RecordDataReadOnly { location: 0, location_type: 0, record_counter: record_counter2, hash_data: loaded_hash, data_base: "".to_string(), } } /// This loads a file that was saved using the "save_database" function which can then be used with the appropriate methods. /// /// # Examples /// /// ``` /// /// let loaded_hash = simplebase::engine::load_hash_database("test1base.txt"); /// /// ``` /// # Panics /// If the file does not exist then this function will panic!() pub fn load_hash_database(database_name: &str) -> RecordData { let mut loaded_hash: HashMap<usize, RecordCharacteristics> = HashMap::new(); let raw_hash_file = file_services::open_file(&database_name).unwrap(); let mut raw_hash_file = String::from_utf8_lossy(&raw_hash_file) .to_owned() .to_string(); if OBFUSCATE { raw_hash_file = obfuscate_data(raw_hash_file.to_string()); } let pre_translated_hash_data: Vec<&str> = raw_hash_file.split("~$").collect(); let mut counter = 0; while counter < pre_translated_hash_data.len() - 1 { let mut database_hold = RecordCharacteristics { record_id: 0, chksum: 0, datatype: 0, location: 0, size: 0, record: "NULL".to_string(), key: "".to_string(), }; database_hold.record_id = pre_translated_hash_data[counter + 1] .parse::<usize>() .unwrap(); database_hold.chksum = pre_translated_hash_data[counter + 2] .parse::<u32>() .unwrap(); database_hold.datatype = pre_translated_hash_data[counter + 3].parse::<u8>().unwrap(); database_hold.location = pre_translated_hash_data[counter + 4] .parse::<usize>() .unwrap(); database_hold.size = pre_translated_hash_data[counter + 5] .parse::<usize>() .unwrap(); database_hold.record = pre_translated_hash_data[counter + 6].to_string(); database_hold.key = pre_translated_hash_data[counter + 7].to_string(); loaded_hash.insert( pre_translated_hash_data[counter].parse::<usize>().unwrap(), database_hold, ); counter += 8; } let mut record_counter2 = 0; match loaded_hash.get(&0) { Some(first_record) => record_counter2 = first_record.record_id, //this is a special value for the first record None => (), } RecordData { location: 0, location_type: 0, record_counter: record_counter2, hash_data: loaded_hash, data_base: "".to_string(), } } ///This function returns a String which is obfuscated. It is not encrypted, its main role is for the data to miss /// being indexed or found in a file search. In 3.0 release this will be fully implimented in the struct as this will /// be a breaking change. /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut loaded_database = load_hash_database("test1base.txt"); /// let a = obfuscate_data("This is a test".to_string()); /// let b = obfuscate_data(a); /// assert_eq!("This is a test".to_string(),b); /// ``` pub fn obfuscate_data(data_to_obfuscate: String) -> String { let string_to_vector = &data_to_obfuscate.as_bytes(); let mut new_obfuscated_vector: Vec<u8> = Vec::new(); let obfuscation_vector = vec![0x34, 0xc5, 0xd4, 0x54, 0x00, 0xd3, 0x2a, 0x55]; let mut counter = 0; for i in string_to_vector.iter() { new_obfuscated_vector.push(i ^ obfuscation_vector[counter]); if counter > obfuscation_vector.len() - 1 { counter = 0; } } let result = String::from_utf8_lossy(&new_obfuscated_vector); result.to_string() } impl Base for i64 { fn addb(self) -> (DataType, String) { (DataType::I64Type, self.to_string()) } } impl Base for String { fn addb(self) -> (DataType, String) { (DataType::StringType, self) } } impl Base for u64 { fn addb(self) -> (DataType, String) { (DataType::U64Type, self.to_string()) } } impl Base for f64 { fn addb(self) -> (DataType, String) { (DataType::F64Type, self.to_string()) } } impl Base for u32 { fn addb(self) -> (DataType, String) { (DataType::U32Type, self.to_string()) } } impl Base for f32 { fn addb(self) -> (DataType, String) { (DataType::F32Type, self.to_string()) } } impl Base for i32 { fn addb(self) -> (DataType, String) { (DataType::I32Type, self.to_string()) } } impl Default for RecordDataReadOnly { fn default() -> RecordDataReadOnly { let mut record_counter = 0; let empty_hash = load_hash_database("empty_database.txt"); let empty_hash = empty_hash.hash_data; if let Some(first_record) = empty_hash.get(&0) { record_counter = first_record.record_id }; let database_contents = "".to_string(); RecordDataReadOnly { location: 0, location_type: 0, record_counter: record_counter, hash_data: empty_hash, data_base: database_contents, } } } impl Default for RecordData { fn default() -> RecordData { let mut record_counter = 0; let empty_hash = load_hash_database("empty_database.txt"); let empty_hash = empty_hash.hash_data; if let Some(first_record) = empty_hash.get(&0) { record_counter = first_record.record_id }; let database_contents = "".to_string(); RecordData { location: 0, location_type: 0, record_counter: record_counter, hash_data: empty_hash, data_base: database_contents, } } } impl RecordDataReadOnly { /// Searches the database for a particular term and returns the matching record in a String vector /// consisting of two values for each match: 1) The record id 2) The contents of the matching record. /// This method is available on read only databases (all methods work on writeable databases). /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database_read_only = load_hash_database_read_only("test1base.txt"); /// let found_records = loaded_database_read_only.find("great"); ///``` pub fn find(&self, what_to_find: &str) -> Vec<String> { let mut search_results: Vec<String> = Vec::new(); for i in &self.hash_data { if let Some(_where_in_filename) = i.1.record.find(&what_to_find) { println!("Record {}", i.1.record); search_results.push(i.0.to_string()); search_results.push(i.1.record.clone()); } } search_results } /// This method returns a record. It returns None if the record does not exist. /// This is also available if a database is opened using the load_hash_database_read_only /// method. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database_read_only = load_hash_database_read_only("test1base.txt"); /// let particular_record = loaded_database_read_only.get_record(1); /// /// pub fn get_record(&self, record_number: usize) -> Option<String> { match self.hash_data.get(&record_number) { Some(record) => Some(record.record.to_owned()), None => None, } } ///This function returns the number of records stored in the database /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut database = load_hash_database("test1base.txt"); /// database.length(); /// ``` pub fn length(&self) -> usize { self.record_counter } /// Searches the database based on key and returns the matching record associated with the key. /// The returned results are collacted in a String vector consisting of two values for each match: /// 1)The record id 2) The contents of the matching record. /// This method is also available on read only databases (all methods work on writeable databases). /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database_read_only = load_hash_database_read_only("test1base.txt"); /// let found_records = loaded_database_read_only.find_key("mob"); ///``` pub fn find_key(&self, what_to_find: &str) -> Vec<String> { let mut search_results: Vec<String> = Vec::new(); //let records: Vec<&str> = self.data_base.split("<E><S>").collect(); for i in &self.hash_data { if let Some(_where_in_filename) = i.1.key.find(&what_to_find) { search_results.push(i.0.to_string()); search_results.push(i.1.record.clone()); } } search_results } ///This function returns the data type (e.g String, u64, f64 etc) of a stored value. This is based on the DataType enum. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database_read_only = load_hash_database_read_only("test1base.txt"); /// loaded_database_read_only.return_data_type(1); /// ``` pub fn return_data_type(&self, record_number: usize) -> u8 { match self.hash_data.get(&record_number) { Some(record) => record.datatype.to_owned(), None => 0, } } /// Calculates a simple chksum on the contents of a record and compares it to the stored /// chksum. This will return false if there is a mismatch. If the record does not exist, /// it will still return true. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut database = new_empty_database(); /// database.add_record_with_key_exclusive("mob".to_string(), "0404111222".to_string()); /// let result = database.verify_record(1); /// assert_eq!(true,result); /// /// ``` pub fn verify_record(&self, record_number: usize) -> bool { match self.hash_data.get(&record_number) { Some(record) => chksum(&record.record.as_bytes()) == record.chksum, None => true, } } /// Checks the checksum in the database for each record. If it does not match, a message is printed stated which record has potentially being /// corrupted. It also returns the amount of corrupted records if there are any. If zero is returned this means that there are no corrupted records. /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database = load_hash_database("test1base.txt"); /// loaded_database.verify_database(); ///``` pub fn verify_database(&self) -> usize { let mut corruption_counter = 0; for i in &self.hash_data { if chksum(&i.1.record.as_bytes()) != i.1.chksum { println!("{} could potentially be corrupted, this does not mean the whole database has been affected, just the mentioned record", i.1.record_id); corruption_counter += 1; } } corruption_counter } } impl RecordData { ///This method adds information to the database with a key as well. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut loaded_database = load_hash_database("test1base.txt"); /// loaded_database.add_record_with_key("mob".to_string(), "0404111222".to_string()); /// /// ``` pub fn add_record_with_key<T>(&mut self, key_to_add: String, record: T) where T: Base, { let (data_type_hold, what_to_save) = record.addb(); self.record_counter += 1; let database_hold = RecordCharacteristics { record_id: self.record_counter, chksum: chksum(&what_to_save.as_bytes()), datatype: data_type(&data_type_hold), location: 1, size: 0, record: what_to_save, key: key_to_add, }; let counter_record = RecordCharacteristics { record_id: self.record_counter, chksum: 0, datatype: 0, location: 0, size: 0, record: "".to_string(), key: "".to_string(), }; self.hash_data.insert(0, counter_record); self.hash_data.insert(self.record_counter, database_hold); } /// This method adds information to the database with a key as well. If the key already exists /// in the database, the information will not be added. The method returns true if successful, /// false, if they key exists already in the database. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut loaded_database = load_hash_database("test1base.txt"); /// loaded_database.add_record_with_key_exclusive("mob".to_string(), "0404111222".to_string()); /// /// ``` pub fn add_record_with_key_exclusive<T>(&mut self, key_to_add: String, record: T) -> bool where T: Base, { let (data_type_hold, what_to_save) = record.addb(); self.record_counter += 1; let database_hold = RecordCharacteristics { record_id: self.record_counter, chksum: chksum(&what_to_save.as_bytes()), datatype: data_type(&data_type_hold), location: 1, size: 0, record: what_to_save, key: key_to_add.clone(), }; let counter_record = RecordCharacteristics { record_id: self.record_counter, chksum: 0, datatype: 0, location: 0, size: 0, record: "".to_string(), key: "".to_string(), }; //This checks to see if the key already exists, if it does it will not add the record //to the database if self.find_key(&key_to_add).is_empty() { //This line updates the record counter in the database self.hash_data.insert(0, counter_record); self.hash_data.insert(self.record_counter, database_hold); true } else { println!( "The key {} already exist, not adding the record to the database", key_to_add ); false } } ///This method adds information to the database. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut loaded_database = load_hash_database("test1base.txt"); /// loaded_database.add_record("0404111222".to_string()); /// /// ``` pub fn add_record<T>(&mut self, record: T) where T: Base, { let (data_type_hold, what_to_save) = record.addb(); self.record_counter += 1; let database_hold = RecordCharacteristics { record_id: self.record_counter, chksum: chksum(&what_to_save.as_bytes()), datatype: data_type(&data_type_hold), location: 1, size: 0, record: what_to_save, key: "".to_string(), }; let counter_record = RecordCharacteristics { record_id: self.record_counter, chksum: 0, datatype: 0, location: 0, size: 0, record: "".to_string(), key: "".to_string(), }; self.hash_data.insert(0, counter_record); self.hash_data.insert(self.record_counter, database_hold); } /// This method deletes a record based on the supplied record number. If the record /// does not exist, it does nothing. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut database = load_hash_database("test1base.txt"); /// database.delete_record(1); /// database.delete_record(1000000); //This will do nothing since the 1000000 record does not exist. /// ``` pub fn delete_record(&mut self, record_number: usize) { self.hash_data.remove(&record_number); } /// Searches the database for a particular term and returns the matching record in a String vector consisting of two values for each match 1) The record id 2) The contents of the matching record. /// This method is available on read only databases (all methods work on writeable databases). /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database = load_hash_database("test1base.txt"); /// let found_records = loaded_database.find("great"); ///``` pub fn find(&self, what_to_find: &str) -> Vec<String> { let mut search_results: Vec<String> = Vec::new(); for i in &self.hash_data { if let Some(_where_in_filename) = i.1.record.find(&what_to_find) { search_results.push(i.0.to_string()); search_results.push(i.1.record.clone()); } } search_results } /// Searches the database key values (if a key value exists for a record- key values are optional) for a particular term and returns the ///matching record in a String vector consisting of two values for each match 1) The record id 2) The contents of the matching record. ///This method is available on read only databases (all methods work on writeable databases). /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database = load_hash_database("test1base.txt"); /// let found_records = loaded_database.find_key("great"); ///``` pub fn find_key(&self, what_to_find: &str) -> Vec<String> { let mut search_results: Vec<String> = Vec::new(); for i in &self.hash_data { if let Some(_where_in_filename) = i.1.key.find(&what_to_find) { search_results.push(i.0.to_string()); search_results.push(i.1.record.clone()); } } search_results } /// This method returns a record. It returns None if the record does not exist. /// This is also available if a database is opened using the load_hash_database_read_only /// method. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database = load_hash_database("test1base.txt"); /// let particular_record = loaded_database.get_record(1); /// /// pub fn get_record(&self, record_number: usize) -> Option<String> { match self.hash_data.get(&record_number) { Some(record) => Some(record.record.to_owned()), None => None, } } ///This function returns the number of records stored in the database /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut database = load_hash_database("test1base.txt"); /// database.length(); /// ``` pub fn length(&self) -> usize { self.record_counter } ///This function returns the data type (e.g String, u64, f64 etc) of a stored value. This is based on the DataType enum. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut database = load_hash_database("test1base.txt"); /// database.return_data_type(1); /// ``` pub fn return_data_type(&self, record_number: usize) -> u8 { match self.hash_data.get(&record_number) { Some(record) => record.datatype.to_owned(), None => 0, } } /// Saves a database hash table to a file. This will need to be run to save /// the database to a file. It is up to the user to impliment this action. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let database = load_hash_database("test1base.txt"); /// database.save_database("test1base.txt"); /// /// ``` pub fn save_database(&self, filename: &str) { save_hash_database(filename, &self.hash_data).unwrap(); } /// Calculates a simple chksum on the contents of a record and compares it to the stored /// chksum. This will return false if there is a mismatch. If the record does not exist, /// it will still return true. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut database = new_empty_database(); /// database.add_record_with_key_exclusive("mob".to_string(), "0404111222".to_string()); /// let result = database.verify_record(1); /// assert_eq!(true,result); /// /// ``` pub fn verify_record(&self, record_number: usize) -> bool { match self.hash_data.get(&record_number) { Some(record) => chksum(&record.record.as_bytes()) == record.chksum, None => true, //return ChksumResult::Empty, } } /// Checks the checksum in the database for each record. If it does not match, a message is printed stated which record has potentially being /// corrupted. It also returns the amount of corrupted records if there are any. If zero is returned this means that there are no corrupted records. /// # Examples /// /// ``` /// use simplebase::engine::*; /// let loaded_database = load_hash_database("test1base.txt"); /// loaded_database.verify_database(); ///``` pub fn verify_database(&self) -> usize { let mut corruption_counter = 0; for i in &self.hash_data { if chksum(&i.1.record.as_bytes()) != i.1.chksum { println!("{} could potentially be corrupted, this does not mean the whole database has been affected, just the mentioned record", i.1.record_id); corruption_counter += 1; } } corruption_counter } } ///This function creates a new empty database which is writable and readable. /// /// # Examples /// /// ``` /// use simplebase::engine::*; /// let mut database = new_empty_database(); /// database.add_record(20); /// ``` pub fn new_empty_database() -> RecordData { let data_type_location: HashMap<usize, RecordCharacteristics> = HashMap::new(); RecordData { location: 0, location_type: 0, record_counter: 0, hash_data: data_type_location, data_base: "".to_string(), } }