Merge pull request #77 from mattico/serde

Add serde support to concrete units

.github/workflows/ci.yml

@@ -37,19 +37,19 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: build
-          args: --lib
+          args: --lib --all-features
 
       - name: Test Library
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --lib -- --test-threads=1
+          args: --lib --all-features -- --test-threads=1
 
       - name: Test Documentation
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --doc
+          args: --doc --all-features
 
       - name: Clippy
         uses: actions-rs/cargo@v1
@@ -60,6 +60,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: doc
+          args: --all-features
 
       - name: Build examples
         uses: marcopolo/cargo@master

Cargo.toml

@@ -11,6 +11,7 @@ repository = "https://github.com/FluenTech/embedded-time/"
 license = "MIT OR Apache-2.0"
 exclude = ["/.github/"]
 autoexamples = false
+resolver = "2"
 # The examples must be their own package due to conflicts with the criterion crate.
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -24,6 +25,7 @@ members = ["examples"]
 
 [dependencies]
 num = { version = "0.3.0", default-features = false }
+serde = { version = "1.0.0", default-features = false, features = ["derive"], optional = true }
 
 [dev-dependencies]
 crossbeam-utils = "0.7.2"

README.md

@@ -253,6 +253,10 @@ Hertz::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1,1_000))) == Ok(He
 - Thorough documentation with examples
 - Example for the nRF52_DK board
 
+## Features
+
+- `serde`: Enables `serde::Deserialize` and `serde::Serialize` implementations for concrete units.
+
 ## Notes
 Some parts of this crate were derived from various sources:
 - [`RTIC`](https://github.com/rtic-rs/cortex-m-rtic)

src/duration.rs

@@ -523,6 +523,7 @@ pub mod units {
         ( $name:ident, ($numer:expr, $denom:expr) ) => {
             /// A duration unit type
             #[derive(Copy, Clone, Eq, Ord, Hash, Debug, Default)]
+            #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
             pub struct $name<T: TimeInt = u32>(pub T);
 
             impl<T: TimeInt> $name<T> {

src/instant.rs

@@ -46,6 +46,7 @@ use num::traits::{WrappingAdd, WrappingSub};
 /// Instant::<SomeClock>::new(23);
 /// ```
 #[derive(Debug)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Instant<Clock: crate::Clock> {
     ticks: Clock::T,
 }

src/rate.rs

@@ -393,6 +393,7 @@ pub mod units {
         ( $name:ident, ($numer:expr, $denom:expr), $desc:literal ) => {
             #[doc = $desc]
             #[derive(Copy, Clone, Eq, Ord, Hash, Debug, Default)]
+            #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
             pub struct $name<T: TimeInt = u32>(pub T);
 
             impl<T: TimeInt> $name<T> {