Improve iter docs and add iter to fuzz

Author: diondokter

example/Cargo.lock

@@ -36,6 +36,7 @@ enum Op {
     Fetch(u8),
     Remove(u8),
     RemoveAll,
+    Iter,
 }
 
 #[derive(Arbitrary, Debug, Clone)]
@@ -263,7 +264,6 @@ fn fuzz(ops: Input, mut cache: impl KeyCacheImpl<u8> + Debug) {
                             }
                         }
                     }
-
                     Err(Error::Corrupted {
                         backtrace: _backtrace,
                     }) => {
@@ -274,6 +274,36 @@ fn fuzz(ops: Input, mut cache: impl KeyCacheImpl<u8> + Debug) {
                     Err(e) => panic!("{e:?}"),
                 }
             }
+            Op::Iter => {
+                let mut iter = block_on(sequential_storage::map::fetch_all_items::<u8, _, _>(
+                    &mut flash,
+                    FLASH_RANGE,
+                    &mut cache,
+                    &mut buf.0,
+                ))
+                .unwrap();
+
+                let mut seen_items = HashMap::new();
+
+                loop {
+                    match block_on(iter.next::<u8, &[u8]>(&mut buf.0)) {
+                        Ok(None) => break,
+                        Ok(Some((key, val))) => {
+                            seen_items.insert(key, val.to_vec());
+                        }
+                        Err(Error::Corrupted {
+                            backtrace: _backtrace,
+                        }) => {
+                            #[cfg(fuzzing_repro)]
+                            eprintln!("Corrupted when removing! Originated from:\n{_backtrace:#}");
+                            panic!("Corrupted!");
+                        }
+                        Err(e) => panic!("{e:?}"),
+                    }
+                }
+
+                assert_eq!(seen_items, map);
+            }
         }
     }
 }

fuzz/fuzz_targets/map.rs

@@ -682,6 +682,7 @@ async fn remove_item_inner<K: Key, S: MultiwriteNorFlash>(
 /// # use sequential_storage::cache::NoCache;
 /// # use mock_flash::MockFlashBase;
 /// # use futures::executor::block_on;
+/// # use std::collections::HashMap;
 /// # type Flash = MockFlashBase<10, 1, 4096>;
 /// # mod mock_flash {
 /// #   include!("mock_flash.rs");
@@ -706,15 +707,18 @@ async fn remove_item_inner<K: Key, S: MultiwriteNorFlash>(
 /// .await
 /// .unwrap();
 ///
+/// let mut all_items = HashMap::new();
+///
 /// // Iterate through all items, suppose the Key and Value types are u8, u32
-/// while let Ok(Some((key, value))) = iterator
+/// while let Some((key, value)) = iterator
 ///     .next::<u8, u32>(&mut data_buffer)
 ///     .await
+///     .unwrap()
 /// {
 ///     // Do somethinmg with the item.
 ///     // Please note that for the same key there might be multiple items returned,
 ///     // the last one is the current active one.
-///     println!("{key}:{value}");
+///     all_items.insert(key, value);
 /// }
 /// # })
 /// ```
@@ -811,6 +815,7 @@ impl<S: NorFlash, CI: CacheImpl> MapItemIter<'_, '_, S, CI> {
 /// # use sequential_storage::cache::NoCache;
 /// # use mock_flash::MockFlashBase;
 /// # use futures::executor::block_on;
+/// # use std::collections::HashMap;
 /// # type Flash = MockFlashBase<10, 1, 4096>;
 /// # mod mock_flash {
 /// #   include!("mock_flash.rs");
@@ -835,14 +840,18 @@ impl<S: NorFlash, CI: CacheImpl> MapItemIter<'_, '_, S, CI> {
 /// .await
 /// .unwrap();
 ///
+/// let mut all_items = HashMap::new();
+///
 /// // Iterate through all items, suppose the Key and Value types are u8, u32
-/// while let Ok(Some((key, value))) = iterator
+/// while let Some((key, value)) = iterator
 ///     .next::<u8, u32>(&mut data_buffer)
 ///     .await
+///     .unwrap()
 /// {
 ///     // Do somethinmg with the item.
 ///     // Please note that for the same key there might be multiple items returned,
 ///     // the last one is the current active one.
+///     all_items.insert(key, value);
 /// }
 /// # })
 /// ```
@@ -1837,7 +1846,6 @@ mod tests {
             }
         }
 
-        // Check the
         assert_eq!(last_value_length, 9);
         assert_eq!(
             &last_value_buffer[..last_value_length],