Merge pull request #14 from tweedegolf/ci

Add CI

.github/workflows/ci.yaml

@@ -0,0 +1,31 @@
+name: Check project
+
+on:
+  push:
+    branches:
+      - master
+  # Run on any PR
+  pull_request:
+
+jobs:
+  fmt:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dtolnay/rust-toolchain@stable
+    - run: cargo fmt --all -- --check
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dtolnay/rust-toolchain@stable
+    - run: cargo test
+
+  clippy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dtolnay/rust-toolchain@stable
+    - run: cargo clippy -- -D warnings
+

src/map.rs

@@ -56,7 +56,7 @@
 //!
 //! #[derive(Debug)]
 //! enum Error {
-//!     // We have no errors in this test
+//!     BufferTooSmall
 //! }
 //!
 //! // Initialize the flash. This can be internal or external
@@ -446,7 +446,7 @@ pub trait StorageItem {
 
     /// Serialize the key-value item into the given buffer.
     /// Returns the number of bytes the buffer was filled with or an error.
-    /// 
+    ///
     /// The serialized data does not have to self-describe its length or do framing.
     /// This crate already stores the length of any item in flash.
     fn serialize_into(&self, buffer: &mut [u8]) -> Result<usize, Self::Error>;