Document that page cound cannot be higher than u16::MAX

embassy-rs · Jul 19, 2024 · bd31e92 · bd31e92
1 parent 571a9c8
commit bd31e92
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/config.rs b/src/config.rs
@@ -73,6 +73,8 @@ pub const PAGE_SIZE: usize = raw::PAGE_SIZE;
 /// This value is just a compile-time upper limit, used to size some in-memory and on-disk data
 /// structures. This allows supporting different memory sizes with the same binary.
 ///
+/// The [`PageID`](crate::types::PageID) is backed by a `u16` so the maximum page count is 65535.
+///
 /// Default: 256
 pub const MAX_PAGE_COUNT: usize = raw::MAX_PAGE_COUNT;
 

diff --git a/src/flash.rs b/src/flash.rs
@@ -17,6 +17,8 @@ pub trait Flash {
     type Error: Debug;
 
     /// Get the page count of the flash storage.
+    ///
+    /// The [`PageID`](crate::types::PageID) is backed by a `u16` so the maximum page count is 65535.
     fn page_count(&self) -> usize;
 
     /// Erase a page.