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
//! # memtable-core //! //! Provides the core structs and traits for use in table manipulation. //! //! Check out full documentation at //! [memtable](https://github.com/chipsenkbeil/memtable-rs). #![cfg_attr(feature = "docs", feature(doc_cfg))] #![cfg_attr(not(feature = "std"), no_std)] #![forbid(missing_docs, missing_debug_implementations)] mod capacity; #[doc(inline)] pub use capacity::Capacity; /// Contains extensions to the library based on extra features pub mod exts; /// Contains iterators and associated traits for traversing portions of tables pub mod iter; mod impls; pub use impls::*; /// Contains lists and associated traits for storing items pub mod list; mod position; #[doc(inline)] pub use position::Position; /// Contains relevant top-level traits, structs, and more to make use of /// this library pub mod prelude; mod utils; /// Re-export alloc as std in the case where we don't have std #[cfg(all(feature = "alloc", not(feature = "std")))] extern crate alloc as std; /// Represents an abstract table of data pub trait Table: Sized { /// The type of data stored in individual cells within the table type Data; /// The type of structure to hold a row of data type Row: list::List<Item = Self::Data>; /// The type of structure to hold a column of data type Column: list::List<Item = Self::Data>; /// Returns the maximum row capacity of the table fn max_row_capacity(&self) -> Capacity; /// Returns the maximum column capacity of the table fn max_column_capacity(&self) -> Capacity; /// Returns the total rows contained in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.row_cnt(), 0); /// # } /// ``` /// /// When has several rows: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// assert_eq!(table.row_cnt(), 2); /// # } /// ``` /// fn row_cnt(&self) -> usize; /// Returns the total columns contained in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.col_cnt(), 0); /// # } /// ``` /// /// When has several columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// assert_eq!(table.col_cnt(), 2); /// # } /// ``` /// fn col_cnt(&self) -> usize; /// Sets the preferred capacity of the table when it comes to total rows /// /// This is a preference, not an absolute, and is up to each table to /// implement if desired; otherwise, this does nothing by default #[allow(unused_variables)] fn set_preferred_row_cnt(&mut self, cnt: usize) {} /// Sets the preferred capacity of the table when it comes to total columns /// /// This is a preference, not an absolute, and is up to each table to /// implement if desired; otherwise, this does nothing by default #[allow(unused_variables)] fn set_preferred_col_cnt(&mut self, cnt: usize) {} /// Returns reference to the cell found at the specified row and column /// /// ### Examples /// /// When retrieving a cell that doesn't exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// assert!(table.cell(0, 3).is_none()); /// # } /// ``` /// /// When retrieving a cell that does exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// assert_eq!(table.cell(0, 2), Some(&3)); /// # } /// ``` fn cell(&self, row: usize, col: usize) -> Option<&Self::Data>; /// Returns mut reference to the cell found at the specified row and column /// /// ### Examples /// /// When retrieving a cell that doesn't exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// assert!(table.mut_cell(0, 3).is_none()); /// # } /// ``` /// /// When retrieving a cell that does exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// /// *table.mut_cell(0, 2).unwrap() = 999; /// assert_eq!(table.cell(0, 2), Some(&999)); /// # } /// ``` fn mut_cell(&mut self, row: usize, col: usize) -> Option<&mut Self::Data>; /// Replaces the given value into the cell of the table at the specified /// row and column, returning the previous value contained in the cell /// /// ### Examples /// /// When replacing a cell that doesn't exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// /// assert!(table.insert_cell(0, 3, 999).is_none()); /// assert_eq!(table.cell(0, 3), Some(&999)); /// # } /// ``` /// /// When replacing a cell that does exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// /// assert_eq!(table.insert_cell(0, 2, 999), Some(3)); /// assert_eq!(table.cell(0, 2), Some(&999)); /// # } /// ``` fn insert_cell(&mut self, row: usize, col: usize, value: Self::Data) -> Option<Self::Data>; /// Removes the given value from the cell at the specified position, but /// does not shift any other cell to fill in the gap /// /// Does not attempt to adjust the capacity within the table /// /// ### Examples /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// /// assert_eq!(table.remove_cell(0, 0), Some(1)); /// assert!(table.remove_cell(0, 0).is_none()); /// # } /// ``` fn remove_cell(&mut self, row: usize, col: usize) -> Option<Self::Data>; /// Returns the total cells (rows * columns) contained in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.len(), 0); /// # } /// ``` /// /// When has several rows & columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// assert_eq!(table.len(), 6); /// # } /// ``` /// fn len(&self) -> usize { self.row_cnt() * self.col_cnt() } /// Returns true if the total cells (rows * columns) contained in the table /// is zero /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert!(table.is_empty()); /// # } /// ``` /// /// When has several rows & columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// assert!(!table.is_empty()); /// # } /// ``` /// fn is_empty(&self) -> bool { self.len() == 0 } /// Returns an iterator of refs through all rows in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.rows().len(), 0); /// # } /// ``` /// /// When has several rows: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// let mut rows = table.rows(); /// assert_eq!(rows.next().unwrap().copied().collect::<Vec<usize>>(), vec![1, 2, 3]); /// assert_eq!(rows.next().unwrap().copied().collect::<Vec<usize>>(), vec![4, 5, 6]); /// assert!(rows.next().is_none()); /// # } /// ``` /// fn rows(&self) -> iter::Rows<Self::Data, Self> { iter::Rows::new(self) } /// Returns an iterator of refs through a specific row in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.row(0).len(), 0); /// # } /// ``` /// /// When has several rows: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// let mut cells = table.row(0); /// assert_eq!(cells.next().copied(), Some(1)); /// assert_eq!(cells.next().copied(), Some(2)); /// assert_eq!(cells.next().copied(), Some(3)); /// assert_eq!(cells.next(), None); /// # } /// ``` /// fn row(&self, idx: usize) -> iter::Row<Self::Data, Self> { iter::Row::new(self, idx) } /// Consumes the table and returns an iterator through a specific row in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.into_row(0).len(), 0); /// # } /// ``` /// /// When has several rows: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// let mut cells = table.into_row(0); /// assert_eq!(cells.next(), Some(1)); /// assert_eq!(cells.next(), Some(2)); /// assert_eq!(cells.next(), Some(3)); /// assert_eq!(cells.next(), None); /// # } /// ``` /// fn into_row(self, idx: usize) -> iter::IntoRow<Self::Data, Self> { iter::IntoRow::new(self, idx) } /// Returns an iterator of refs through all columns in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.columns().len(), 0); /// # } /// ``` /// /// When has several columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// let mut columns = table.columns(); /// assert_eq!(columns.next().unwrap().copied().collect::<Vec<usize>>(), vec![1, 2, 3]); /// assert_eq!(columns.next().unwrap().copied().collect::<Vec<usize>>(), vec![4, 5, 6]); /// assert!(columns.next().is_none()); /// # } /// ``` /// fn columns(&self) -> iter::Columns<Self::Data, Self> { iter::Columns::new(self) } /// Returns an iterator of refs through a specific column in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.column(0).len(), 0); /// # } /// ``` /// /// When has several columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// let mut cells = table.column(0); /// assert_eq!(cells.next().copied(), Some(1)); /// assert_eq!(cells.next().copied(), Some(2)); /// assert_eq!(cells.next().copied(), Some(3)); /// assert_eq!(cells.next(), None); /// # } /// ``` /// fn column(&self, idx: usize) -> iter::Column<Self::Data, Self> { iter::Column::new(self, idx) } /// Consumes the table and returns an iterator through a specific column in the table /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.into_column(0).len(), 0); /// # } /// ``` /// /// When has several columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// let mut cells = table.into_column(0); /// assert_eq!(cells.next(), Some(1)); /// assert_eq!(cells.next(), Some(2)); /// assert_eq!(cells.next(), Some(3)); /// assert_eq!(cells.next(), None); /// # } /// ``` /// fn into_column(self, idx: usize) -> iter::IntoColumn<Self::Data, Self> { iter::IntoColumn::new(self, idx) } /// Returns an iterator of refs through all cells in the table, starting /// from the first row, iterating through all cells from beginning to end, /// and then moving on to the next row /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.cells().len(), 0); /// # } /// ``` /// /// When has several rows & columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// let mut cells = table.cells(); /// assert_eq!(cells.next(), Some(&1)); /// assert_eq!(cells.next(), Some(&2)); /// assert_eq!(cells.next(), Some(&3)); /// assert_eq!(cells.next(), Some(&4)); /// assert_eq!(cells.next(), Some(&5)); /// assert_eq!(cells.next(), Some(&6)); /// assert_eq!(cells.next(), None); /// # } /// ``` /// fn cells(&self) -> iter::Cells<Self::Data, Self> { iter::Cells::new(self) } /// Consumes the table and returns an iterator through all cells in the /// table, starting from the first row, iterating through all cells from /// beginning to end, and then moving on to the next row /// /// ### Examples /// /// When empty: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let table = DynamicTable::<usize>::new(); /// assert_eq!(table.into_cells().len(), 0); /// # } /// ``` /// /// When has several rows & columns: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::<usize>::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// let mut cells = table.into_cells(); /// assert_eq!(cells.next(), Some(1)); /// assert_eq!(cells.next(), Some(2)); /// assert_eq!(cells.next(), Some(3)); /// assert_eq!(cells.next(), Some(4)); /// assert_eq!(cells.next(), Some(5)); /// assert_eq!(cells.next(), Some(6)); /// assert_eq!(cells.next(), None); /// # } /// ``` /// fn into_cells(self) -> iter::IntoCells<Self::Data, Self> { iter::IntoCells::new(self) } /// Returns whether or not a cell exists at the specified row & column. Note /// that this is not the same as whether or not the table's current row & /// column range would include a cell at that position! Rather, this is /// reporting if a cell actually exists /// /// ### Examples /// /// When has checking for a cell that doesn't exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// assert!(!table.has_cell(0, 3)); /// # } /// ``` /// /// When has checking for a cell that does exist: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// assert!(table.has_cell(0, 2)); /// # } /// ``` fn has_cell(&self, row: usize, col: usize) -> bool { self.cell(row, col).is_some() } /// Inserts a new row into the table at the given position, shifting down /// all rows after it /// /// ### Examples /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// table.insert_row(0, vec![7, 8, 9]); /// /// let mut row = table.row(0); /// assert_eq!(row.next(), Some(&7)); /// assert_eq!(row.next(), Some(&8)); /// assert_eq!(row.next(), Some(&9)); /// assert!(row.next().is_none()); /// /// let mut row = table.row(1); /// assert_eq!(row.next(), Some(&1)); /// assert_eq!(row.next(), Some(&2)); /// assert_eq!(row.next(), Some(&3)); /// assert!(row.next().is_none()); /// /// let mut row = table.row(2); /// assert_eq!(row.next(), Some(&4)); /// assert_eq!(row.next(), Some(&5)); /// assert_eq!(row.next(), Some(&6)); /// assert!(row.next().is_none()); /// # } /// ``` fn insert_row<I: IntoIterator<Item = Self::Data>>(&mut self, row: usize, cells: I) { // First, we need to shift down all cells that would appear at this // row or later if self.row_cnt() > row { // NOTE: Need to go in reverse, otherwise we would overwrite the // row below when trying to shift down! for row in (row..self.row_cnt()).rev() { for col in (0..self.col_cnt()).rev() { if let Some(x) = self.remove_cell(row, col) { self.insert_cell(row + 1, col, x); } } } } for (col, x) in cells.into_iter().enumerate() { self.insert_cell(row, col, x); } } /// Pushes a row to the end of the table /// /// ### Examples /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// let mut row = table.row(0); /// assert_eq!(row.next(), Some(&1)); /// assert_eq!(row.next(), Some(&2)); /// assert_eq!(row.next(), Some(&3)); /// assert!(row.next().is_none()); /// /// let mut row = table.row(1); /// assert_eq!(row.next(), Some(&4)); /// assert_eq!(row.next(), Some(&5)); /// assert_eq!(row.next(), Some(&6)); /// assert!(row.next().is_none()); /// # } /// ``` fn push_row<I: IntoIterator<Item = Self::Data>>(&mut self, cells: I) { self.insert_row(self.row_cnt(), cells) } /// Removes the row at the specified position, shifting up all rows after it /// /// If the row does not exist, then an empty row will be returned /// /// ### Examples /// /// Removing from the front: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// assert_eq!(table.remove_row(0), Some(DynamicList::from([1, 2, 3]))); /// assert_eq!(table.remove_row(0), Some(DynamicList::from([4, 5, 6]))); /// assert_eq!(table.remove_row(0), None); /// # } /// ``` /// /// Removing from the back: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// assert_eq!(table.remove_row(1), Some(DynamicList::from([4, 5, 6]))); /// assert_eq!(table.remove_row(1), None); /// assert_eq!(table.remove_row(0), Some(DynamicList::from([1, 2, 3]))); /// assert_eq!(table.remove_row(0), None); /// # } /// ``` fn remove_row(&mut self, row: usize) -> Option<Self::Row> { let row_cnt = self.row_cnt(); let col_cnt = self.col_cnt(); // If not in table range, return none if row >= row_cnt { return None; } // First, we remove all cells in the specified row and add them to the // temporary table use list::List; let tmp = Self::Row::new_filled_with(col_cnt, |col| self.remove_cell(row, col)); // Second, we need to shift up all cells that would appear after this row for row in (row + 1)..row_cnt { for col in 0..col_cnt { if let Some(x) = self.remove_cell(row, col) { self.insert_cell(row - 1, col, x); } } } // Flag to table that the preferred row capacity is now one less // if the row we removed was within capacity if row < row_cnt { self.set_preferred_row_cnt(row_cnt - 1); } Some(tmp) } /// Pops a row off the end of the table /// /// ### Examples /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_row(vec![1, 2, 3]); /// table.push_row(vec![4, 5, 6]); /// /// assert_eq!(table.pop_row(), Some(DynamicList::from([4, 5, 6]))); /// assert_eq!(table.pop_row(), Some(DynamicList::from([1, 2, 3]))); /// assert_eq!(table.pop_row(), None); /// # } /// ``` fn pop_row(&mut self) -> Option<Self::Row> { let max_rows = self.row_cnt(); self.remove_row(if max_rows > 0 { max_rows - 1 } else { 0 }) } /// Inserts a new column into the table at the given position, shifting right /// all columns after it /// /// ### Examples /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// table.insert_column(0, vec![7, 8, 9]); /// /// let mut column = table.column(0); /// assert_eq!(column.next(), Some(&7)); /// assert_eq!(column.next(), Some(&8)); /// assert_eq!(column.next(), Some(&9)); /// assert!(column.next().is_none()); /// /// let mut column = table.column(1); /// assert_eq!(column.next(), Some(&1)); /// assert_eq!(column.next(), Some(&2)); /// assert_eq!(column.next(), Some(&3)); /// assert!(column.next().is_none()); /// /// let mut column = table.column(2); /// assert_eq!(column.next(), Some(&4)); /// assert_eq!(column.next(), Some(&5)); /// assert_eq!(column.next(), Some(&6)); /// assert!(column.next().is_none()); /// # } /// ``` fn insert_column<I: IntoIterator<Item = Self::Data>>(&mut self, col: usize, cells: I) { // First, we need to shift right all cells that would appear at this // column or later if self.col_cnt() > col { // NOTE: Need to go in reverse, otherwise we would overwrite the // column right when trying to shift right! for row in (0..self.row_cnt()).rev() { for col in (col..self.col_cnt()).rev() { if let Some(x) = self.remove_cell(row, col) { self.insert_cell(row, col + 1, x); } } } } for (row, x) in cells.into_iter().enumerate() { self.insert_cell(row, col, x); } } /// Pushes a column to the end of the table /// /// ### Examples /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// let mut column = table.column(0); /// assert_eq!(column.next(), Some(&1)); /// assert_eq!(column.next(), Some(&2)); /// assert_eq!(column.next(), Some(&3)); /// assert!(column.next().is_none()); /// /// let mut column = table.column(1); /// assert_eq!(column.next(), Some(&4)); /// assert_eq!(column.next(), Some(&5)); /// assert_eq!(column.next(), Some(&6)); /// assert!(column.next().is_none()); /// # } /// ``` fn push_column<I: IntoIterator<Item = Self::Data>>(&mut self, cells: I) { self.insert_column(self.col_cnt(), cells) } /// Removes the column at the specified position, shifting left all columns after it /// /// If the column does not exist, then an empty column will be returned /// /// ### Examples /// /// Removing from the front: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// assert_eq!(table.remove_column(0), Some(DynamicList::from([1, 2, 3]))); /// assert_eq!(table.remove_column(0), Some(DynamicList::from([4, 5, 6]))); /// assert_eq!(table.remove_column(0), None); /// # } /// ``` /// /// Removing from the the back: /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// assert_eq!(table.remove_column(1), Some(DynamicList::from([4, 5, 6]))); /// assert_eq!(table.remove_column(1), None); /// assert_eq!(table.remove_column(0), Some(DynamicList::from([1, 2, 3]))); /// assert_eq!(table.remove_column(0), None); /// # } /// ``` fn remove_column(&mut self, col: usize) -> Option<Self::Column> { let row_cnt = self.row_cnt(); let col_cnt = self.col_cnt(); // If not in table range, return none if col >= col_cnt { return None; } // First, we remove all cells in the specified column and add them to the // temporary table use list::List; let tmp = Self::Column::new_filled_with(row_cnt, |row| self.remove_cell(row, col)); // Second, we need to shift left all cells that would appear after this column for row in 0..row_cnt { for col in (col + 1)..col_cnt { if let Some(x) = self.remove_cell(row, col) { self.insert_cell(row, col - 1, x); } } } // Flag to table that the preferred column capacity is now one less // if the column we removed was within capacity if col < col_cnt { self.set_preferred_col_cnt(col_cnt - 1); } Some(tmp) } /// Pops a column off the end of the table /// /// ### Examples /// /// ``` /// # #[cfg(not(any(feature = "alloc", feature = "std")))] /// # fn main() {} /// # #[cfg(any(feature = "alloc", feature = "std"))] /// # fn main() { /// # use memtable_core::prelude::*; /// let mut table = DynamicTable::new(); /// table.push_column(vec![1, 2, 3]); /// table.push_column(vec![4, 5, 6]); /// /// assert_eq!(table.pop_column(), Some(DynamicList::from([4, 5, 6]))); /// assert_eq!(table.pop_column(), Some(DynamicList::from([1, 2, 3]))); /// assert_eq!(table.pop_column(), None); /// # } /// ``` fn pop_column(&mut self) -> Option<Self::Column> { let max_cols = self.col_cnt(); self.remove_column(if max_cols > 0 { max_cols - 1 } else { 0 }) } } #[cfg(test)] mod tests { use super::*; // For a couple of tests, we also provide a dummy table with no actual data #[derive(Default)] struct DummyTable { row_cnt: usize, col_cnt: usize, last_requested_row_capacity: Option<usize>, last_requested_column_capacity: Option<usize>, } impl DummyTable { pub fn new(row_cnt: usize, col_cnt: usize) -> Self { Self { row_cnt, col_cnt, ..Default::default() } } } impl Table for DummyTable { type Data = (); type Row = list::FixedList<Self::Data, 0>; type Column = list::FixedList<Self::Data, 0>; fn max_row_capacity(&self) -> Capacity { Capacity::Unlimited } fn max_column_capacity(&self) -> Capacity { Capacity::Unlimited } fn set_preferred_row_cnt(&mut self, row: usize) { self.last_requested_row_capacity = Some(row); } fn set_preferred_col_cnt(&mut self, col: usize) { self.last_requested_column_capacity = Some(col); } fn row_cnt(&self) -> usize { self.row_cnt } fn col_cnt(&self) -> usize { self.col_cnt } fn cell(&self, _row: usize, _col: usize) -> Option<&Self::Data> { None } fn mut_cell(&mut self, _row: usize, _col: usize) -> Option<&mut Self::Data> { None } fn insert_cell( &mut self, _row: usize, _col: usize, _value: Self::Data, ) -> Option<Self::Data> { None } fn remove_cell(&mut self, _row: usize, _col: usize) -> Option<Self::Data> { None } } #[test] fn remove_row_should_set_new_row_capacity_if_valid_row_removed() { let mut table = DummyTable::new(2, 0); assert_eq!(table.last_requested_row_capacity, None); // Remove out of range, so should not call table.remove_row(2); assert_eq!(table.last_requested_row_capacity, None); // Remove in range, so should call table.remove_row(1); assert_eq!(table.last_requested_row_capacity, Some(1)); } #[test] fn remove_column_should_set_new_column_capacity_if_valid_column_removed() { let mut table = DummyTable::new(0, 2); assert_eq!(table.last_requested_column_capacity, None); // Remove out of range, so should not call table.remove_column(2); assert_eq!(table.last_requested_column_capacity, None); // Remove in range, so should call table.remove_column(1); assert_eq!(table.last_requested_column_capacity, Some(1)); } }