Skip to content

Commit

Permalink
Ready for release
Browse files Browse the repository at this point in the history
  • Loading branch information
diondokter committed Dec 16, 2023
1 parent b3b0e99 commit 9ffb7b6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "sequential-storage"
version = "0.6.0"
version = "0.6.1"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "A crate for storing data in flash with minimal erase cycles."
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,16 @@ You should only lose data when you give permission.
Peeking and popping look at the oldest data it can find.
When popping, the item is also erased.

When using peek_many, you can look at all data from oldest to newest.

## Changelog

(DD-MM-YY)

### 0.6.1 - 16-12-23

- Added queue peek_many and pop_many ([#12](https://github.com/tweedegolf/sequential-storage/pull/12))

### 0.6.0 - 21-11-23

- *Breaking* Internal overhaul of the code. Both map and queue now use the same `item` module to store and read their data with.
Expand Down
4 changes: 2 additions & 2 deletions src/queue.rs
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ pub fn peek_many<S: NorFlash>(flash: &mut S, flash_range: Range<u32>) -> PeekIte
///
/// If you also want to remove the data use [pop].
///
/// The data is written to the given `data_buffer`` and the part that was written is returned.
/// The data is written to the given `data_buffer` and the part that was written is returned.
/// It is valid to only use the length of the returned slice and use the original `data_buffer`.
/// The `data_buffer` may contain extra data on ranges after the returned slice.
/// You should not depend on that data.
Expand Down Expand Up @@ -208,7 +208,7 @@ pub fn pop_many<S: MultiwriteNorFlash>(
///
/// If you don't want to remove the data use [peek].
///
/// The data is written to the given `data_buffer`` and the part that was written is returned.
/// The data is written to the given `data_buffer` and the part that was written is returned.
/// It is valid to only use the length of the returned slice and use the original `data_buffer`.
/// The `data_buffer` may contain extra data on ranges after the returned slice.
/// You should not depend on that data.
Expand Down

0 comments on commit 9ffb7b6

Please sign in to comment.