From 6341cf35d3c0ac3978471e8243cefc092ea56ca7 Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Sat, 10 Dec 2022 18:09:00 +0100
Subject: [PATCH] added doc test / example as well

---
 src/time/cuc.rs | 61 +++++++++++++++++++++++++++++++++++++++++++------
 src/time/mod.rs |  3 +--
 2 files changed, 55 insertions(+), 9 deletions(-)

diff --git a/src/time/cuc.rs b/src/time/cuc.rs
index 6a5c491..fb1438c 100644
--- a/src/time/cuc.rs
+++ b/src/time/cuc.rs
@@ -121,6 +121,29 @@ pub struct FractionalPart(FractionalResolution, u32);
 /// Having a preamble field of one byte limits the width of the counter
 /// type (generally seconds) to 4 bytes and the width of the fractions type to 3 bytes. This limits
 /// the maximum time stamp size to [MAX_CUC_LEN_SMALL_PREAMBLE] (8 bytes).
+///
+/// # Example
+///
+/// ```
+/// use spacepackets::time::cuc::{FractionalResolution, TimeProviderCcsdsEpoch};
+/// use spacepackets::time::{TimeWriter, CcsdsTimeCodes, TimeReader, CcsdsTimeProvider};
+///
+/// // Highest fractional resolution
+/// let timestamp_now = TimeProviderCcsdsEpoch::from_now(FractionalResolution::SixtyNs).expect("creating cuc stamp failed");
+/// let mut raw_stamp = [0; 16];
+/// {
+///     let written = timestamp_now.write_to_bytes(&mut raw_stamp).expect("writing timestamp failed");
+///     assert_eq!((raw_stamp[0] >> 4) & 0b111, CcsdsTimeCodes::CucCcsdsEpoch as u8);
+///     // 1 byte preamble + 4 byte counter + 3 byte fractional part
+///     assert_eq!(written, 8);
+/// }
+/// {
+///     let read_result = TimeProviderCcsdsEpoch::from_bytes(&raw_stamp);
+///     assert!(read_result.is_ok());
+///     let stamp_deserialized = read_result.unwrap();
+///     assert_eq!(stamp_deserialized, timestamp_now);
+/// }
+/// ```
 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct TimeProviderCcsdsEpoch {
@@ -288,11 +311,8 @@ impl TimeProviderCcsdsEpoch {
         let ccsds_epoch = unix_epoch_to_ccsds_epoch(now.as_secs());
         let fractions =
             fractional_part_from_subsec_ns(fraction_resolution, now.subsec_nanos() as u64);
-        Ok(Self {
-            pfield: 0,
-            counter: WidthCounterPair(4, ccsds_epoch as u32),
-            fractions,
-        })
+        Self::new_with_fractions(ccsds_epoch as u32, fractions)
+            .map_err(|e| TimestampError::CucError(e).into())
     }
 
     #[cfg(feature = "std")]
@@ -330,10 +350,14 @@ impl TimeProviderCcsdsEpoch {
         if res == FractionalResolution::Seconds {
             self.fractions = None;
         }
+        let mut update_fractions = true;
         if let Some(existing_fractions) = self.fractions {
-            if existing_fractions.0 != res {
-                self.fractions = Some(FractionalPart(res, 0));
+            if existing_fractions.0 == res {
+                update_fractions = false;
             }
+        };
+        if update_fractions {
+            self.fractions = Some(FractionalPart(res, 0));
         }
     }
 
@@ -863,4 +887,27 @@ mod tests {
             / (10_u64.pow(9) / fractional_res_to_div(FractionalResolution::FifteenUs) as u64);
         assert_eq!(fractional_part, 101);
     }
+
+    #[test]
+    fn update_fractions() {
+        let mut stamp = TimeProviderCcsdsEpoch::new(2000);
+        let res = stamp.set_fractions(FractionalPart(FractionalResolution::SixtyNs, 5000));
+        assert!(res.is_ok());
+        assert!(stamp.fractions.is_some());
+        let fractions = stamp.fractions.unwrap();
+        assert_eq!(fractions.0, FractionalResolution::SixtyNs);
+        assert_eq!(fractions.1, 5000);
+    }
+
+    #[test]
+    fn set_fract_resolution() {
+        let mut stamp = TimeProviderCcsdsEpoch::new(2000);
+        stamp.set_fractional_resolution(FractionalResolution::SixtyNs);
+        assert!(stamp.fractions.is_some());
+        let fractions = stamp.fractions.unwrap();
+        assert_eq!(fractions.0, FractionalResolution::SixtyNs);
+        assert_eq!(fractions.1, 0);
+        let res = stamp.update_from_now();
+        assert!(res.is_ok());
+    }
 }
diff --git a/src/time/mod.rs b/src/time/mod.rs
index 37c9449..26d74b2 100644
--- a/src/time/mod.rs
+++ b/src/time/mod.rs
@@ -7,7 +7,6 @@ use core::fmt::{Display, Formatter};
 #[cfg(not(feature = "std"))]
 use num_traits::float::FloatCore;
 
-use crate::time::cuc::CucError;
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 #[cfg(feature = "std")]
@@ -73,7 +72,7 @@ impl From<cds::CdsError> for TimestampError {
 }
 
 impl From<cuc::CucError> for TimestampError {
-    fn from(e: CucError) -> Self {
+    fn from(e: cuc::CucError) -> Self {
         TimestampError::CucError(e)
     }
 }