Merge branch 'storage-rework' of github.com:rust-embedded-community/embedded-storage into storage-rework

Author: MathiasKoch

Cargo.toml

@@ -15,4 +15,4 @@ keywords = ["storage"]
 categories = ["embedded", "hardware-support", "no-std"]
 
 [dependencies]
-heapless = "^0.5"
+heapless = "^0.5"

src/lib.rs

@@ -27,7 +27,7 @@ pub trait ReadStorage {
 	/// operation at the given address offset, and reading `bytes.len()` bytes.
 	///
 	///	This should throw an error in case `bytes.len()` will be larger than
-	/// `self.capacity()`.
+	/// `self.capacity() - offset`.
 	fn try_read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>;
 
 	/// The capacity of the storage peripheral in bytes.

src/nor_flash.rs

@@ -11,7 +11,7 @@ pub trait ReadNorFlash {
 	/// Read a slice of data from the storage peripheral, starting the read
 	/// operation at the given address offset, and reading `bytes.len()` bytes.
 	///
-	///	This should throw an error in case `bytes.len()` will be larger than
+	/// This should throw an error in case `bytes.len()` will be larger than
 	/// the peripheral end address.
 	fn try_read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>;