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-12 14:40:30 +02:00
parent 7b21eba5df
commit d721949806
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -33,12 +33,12 @@ const MAX_ERASE_CYCLE: usize = 65535;
/// Maximum page index. /// Maximum page index.
/// ///
/// Thus the maximum number of pages in one more than this number. /// Thus the maximum number of pages is one more than this number.
const MAX_PAGE_INDEX: usize = 63; const MAX_PAGE_INDEX: usize = 63;
/// Maximum key index. /// Maximum key index.
/// ///
/// Thus the number of keys in one more than this number. /// Thus the number of keys is one more than this number.
const MAX_KEY_INDEX: usize = 4095; const MAX_KEY_INDEX: usize = 4095;
/// Maximum length in bytes of a user payload. /// Maximum length in bytes of a user payload.
@@ -106,8 +106,8 @@ impl Format {
/// - The size of a word evenly divides the size of a page. /// - The size of a word evenly divides the size of a page.
/// - A page contains at least 8 words. /// - A page contains at least 8 words.
/// - A page contains at most [`MAX_PAGE_SIZE`] bytes. /// - A page contains at most [`MAX_PAGE_SIZE`] bytes.
/// - There is at least 3 pages. /// - There are at least 3 pages.
/// - There is at most [`MAX_PAGE_INDEX`]` + 1` pages. /// - There are at most [`MAX_PAGE_INDEX`]` + 1` pages.
/// - A word can be written at least twice between erase cycles. /// - A word can be written at least twice between erase cycles.
/// - A page can be erased at most [`MAX_ERASE_CYCLE`] times. /// - A page can be erased at most [`MAX_ERASE_CYCLE`] times.
/// ///