kmwebnet/OpenSK
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Julien Cretin
2020-10-23 15:38:21 +02:00
parent 34ad35fdc1
commit f52ea953b8
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
libraries/persistent_store/src/buffer.rs
View File

@@ -19,6 +19,9 @@ use alloc::vec;
/// Simulates a flash storage using a buffer in memory. /// Simulates a flash storage using a buffer in memory.
/// ///
/// This buffer storage can be used in place of an actual flash storage. It is particularly useful
/// for tests and fuzzing, for which it has dedicated functionalities.
///
/// This storage tracks how many times words are written between page erase cycles, how many times /// This storage tracks how many times words are written between page erase cycles, how many times
/// pages are erased, and whether an operation flips bits in the wrong direction (optional). /// pages are erased, and whether an operation flips bits in the wrong direction (optional).
/// Operations panic if those conditions are broken. This storage also permits to interrupt /// Operations panic if those conditions are broken. This storage also permits to interrupt
@@ -223,6 +226,11 @@ impl BufferStorage {
/// starting at byte `index`, but actually only `value` was written. Word counters are /// starting at byte `index`, but actually only `value` was written. Word counters are
/// incremented only if their value would change and they would be completely written. /// incremented only if their value would change and they would be completely written.
/// ///
/// # Preconditions
///
/// - `index` must be word-aligned.
/// - `value` and `complete` must have the same word-aligned length.
///
/// # Panics /// # Panics
/// ///
/// Panics if the maximum number of writes per word is reached. /// Panics if the maximum number of writes per word is reached.