Skip to content

Commit

Permalink
Ready for release 0.9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
diondokter committed Feb 11, 2024
1 parent 2885479 commit 3b9a6de
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## Unreleased

## 0.9.0 11-02-24

- *Breaking:* Storage item key must now also be clone
- Added KeyPointerCache which significantly helps out the map

Expand Down
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.8.1"
version = "0.9.0"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "A crate for storing data in flash with minimal erase cycles."
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ For any update, consult the changelog to see what changed. Any externally notica

The `_test` feature of the crate is considered private. It and anything it enables is not covered by semver.

The performance of any of the cache types is not covered by semver either. If you use this crate in a
performance sensitive application, then make sure that everything remains working even when no cache is used.
That way you've covered the worst-case execution time for that part of your application.

A cache performance regression might be a bug though. Open an issue to discus your situation if you find a regression.

## Features

- Key value datastore (Map)
Expand Down Expand Up @@ -124,7 +130,7 @@ An item is considered erased when its data CRC field is 0.
*NOTE: This means the data itself is still stored on the flash when it's considered erased.*
*Depending on your usecase, this might not be secure*

The length is a u16, so any item cannot be longer than 0xFFFF or `page size - the item header (aligned to word boundary) - page state (2 words)`.
The length is a u16, so any item cannot be longer than 0xFFFF or `page size - the item header (padded to word boundary) - page state (2 words)`.

### Inner workings for map

Expand Down

0 comments on commit 3b9a6de

Please sign in to comment.