Merge pull request #20 from rust-embedded-community/prepare/release-v0.2.0

Do preperations for new 0.2.0 release on Changelog & Cargo.toml

Author: MathiasKoch

CHANGELOG.md

@@ -7,11 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## [0.2.0] - 2021-09-15
+
 - Removed `try_` prefix from all trait methods.
+- Add RMW helpers for Nor flashes, implementing `Storage` trait.
 
 ## [0.1.0] - 2021-05-18
 
 Initial release to crates.io.
 
-[Unreleased]: https://github.com/rust-embedded-community/embedded-storage/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/rust-embedded-community/embedded-storage/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/rust-embedded-community/embedded-storage/releases/tag/v0.2.0
 [0.1.0]: https://github.com/rust-embedded-community/embedded-storage/releases/tag/v0.1.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "embedded-storage"
-version = "0.1.0"
+version = "0.2.0"
 authors = [
     "Mathias Koch <[email protected]>",
 ]

src/nor_flash.rs

@@ -113,9 +113,9 @@ where
 {
 	type Error = S::Error;
 
-	fn try_read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> {
+	fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> {
 		// Nothing special to be done for reads
-		self.storage.try_read(offset, bytes)
+		self.storage.read(offset, bytes)
 	}
 
 	fn capacity(&self) -> usize {
@@ -127,7 +127,7 @@ impl<'a, S> Storage for RmwNorFlashStorage<'a, S>
 where
 	S: NorFlash,
 {
-	fn try_write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> {
+	fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> {
 		// Perform read/modify/write operations on the byte slice.
 		let last_page = self.storage.capacity() / S::ERASE_SIZE;
 
@@ -140,17 +140,17 @@ where
 			let offset_into_page = addr.saturating_sub(page.start) as usize;
 
 			self.storage
-				.try_read(page.start, &mut self.merge_buffer[..S::ERASE_SIZE])?;
+				.read(page.start, &mut self.merge_buffer[..S::ERASE_SIZE])?;
 
 			// If we cannot write multiple times to the same page, we will have to erase it
-			self.storage.try_erase(page.start, page.end())?;
+			self.storage.erase(page.start, page.end())?;
 			self.merge_buffer[..S::ERASE_SIZE]
 				.iter_mut()
 				.skip(offset_into_page)
 				.zip(data)
 				.for_each(|(byte, input)| *byte = *input);
 			self.storage
-				.try_write(page.start, &self.merge_buffer[..S::ERASE_SIZE])?;
+				.write(page.start, &self.merge_buffer[..S::ERASE_SIZE])?;
 		}
 		Ok(())
 	}
@@ -188,9 +188,9 @@ where
 {
 	type Error = S::Error;
 
-	fn try_read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> {
+	fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> {
 		// Nothing special to be done for reads
-		self.storage.try_read(offset, bytes)
+		self.storage.read(offset, bytes)
 	}
 
 	fn capacity(&self) -> usize {
@@ -202,7 +202,7 @@ impl<'a, S> Storage for RmwMultiwriteNorFlashStorage<'a, S>
 where
 	S: MultiwriteNorFlash,
 {
-	fn try_write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> {
+	fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> {
 		// Perform read/modify/write operations on the byte slice.
 		let last_page = self.storage.capacity() / S::ERASE_SIZE;
 
@@ -215,7 +215,7 @@ where
 			let offset_into_page = addr.saturating_sub(page.start) as usize;
 
 			self.storage
-				.try_read(page.start, &mut self.merge_buffer[..S::ERASE_SIZE])?;
+				.read(page.start, &mut self.merge_buffer[..S::ERASE_SIZE])?;
 
 			let rhs = &self.merge_buffer[offset_into_page..S::ERASE_SIZE];
 			let is_subset = data.iter().zip(rhs.iter()).all(|(a, b)| *a & *b == *a);
@@ -229,16 +229,16 @@ where
 				self.merge_buffer[..aligned_end].fill(0xff);
 				self.merge_buffer[offset..offset + data.len()].copy_from_slice(data);
 				self.storage
-					.try_write(addr - offset as u32, &self.merge_buffer[..aligned_end])?;
+					.write(addr - offset as u32, &self.merge_buffer[..aligned_end])?;
 			} else {
-				self.storage.try_erase(page.start, page.end())?;
+				self.storage.erase(page.start, page.end())?;
 				self.merge_buffer[..S::ERASE_SIZE]
 					.iter_mut()
 					.skip(offset_into_page)
 					.zip(data)
 					.for_each(|(byte, input)| *byte = *input);
 				self.storage
-					.try_write(page.start, &self.merge_buffer[..S::ERASE_SIZE])?;
+					.write(page.start, &self.merge_buffer[..S::ERASE_SIZE])?;
 			}
 		}
 		Ok(())