Develop (#42)

* Remove commented out section
  - Make Utf8Buffer public
* Tracker: add more public functions 
* Formatting: make Utf8Buffer public and format API as well

---------

Signed-off-by: Guillaume W. Bres <[email protected]>

Author: gwbres

src/lib.rs

@@ -11,10 +11,6 @@
  * Documentation: https://github.com/rtk-rs/cggtts
  */
 
-// #[cfg(feature = "tracker")]
-// #[cfg_attr(docsrs, doc(cfg(feature = "tracker")))]
-// pub mod tracker;
-
 extern crate gnss_rs as gnss;
 
 use gnss::prelude::{Constellation, SV};
@@ -43,11 +39,10 @@ mod tracker;
 #[cfg(test)]
 mod tests;
 
+pub mod buffer;
 pub mod errors;
 pub mod track;
 
-pub(crate) mod buffer;
-
 #[cfg(feature = "serde")]
 #[macro_use]
 extern crate serde;

src/track/formatting.rs

@@ -22,7 +22,9 @@ fn fmt_saturated_f64(nb: f64, scaling: f64, sat: i64, padding: usize) -> String
 }
 
 impl Track {
-    pub(crate) fn format<W: Write>(
+    /// Format [Track] into mutable [BufWriter].
+    /// Requires a pre-allocated [Utf8Buffer].
+    pub fn format<W: Write>(
         &self,
         writer: &mut BufWriter<W>,
         buffer: &mut Utf8Buffer,

src/tracker/fit.rs

@@ -9,6 +9,9 @@ use crate::prelude::{Duration, Epoch, FittedData, SV};
 /// CGGTTS track formation errors
 #[derive(Debug, Clone, Error)]
 pub enum FitError {
+    /// Unknown satellite (not tracked at all)
+    #[error("unknown satellite (not tracked at all)")]
+    UnknownSatellite,
     /// At least two symbols are required to fit
     #[error("track fitting requires at least 3 observations")]
     NotEnoughSymbols,

src/tracker/mod.rs

@@ -46,4 +46,19 @@ impl SkyTracker {
             self.trackers.insert(satellite, new);
         }
     }
+
+    /// Attempt new satellite track fitting.
+    /// ## Input
+    /// - satellite: [SV] that must have been tracked.
+    /// That tracking duration might have to respect external requirements.
+    /// ## Output
+    /// - fitted: [FittedData] that you can turn into a valid
+    /// CGGTTS track if you provide a little more information.
+    pub fn track_fit(&mut self, satellite: SV) -> Result<FittedData, FitError> {
+        if let Some(sv) = self.trackers.get_mut(&satellite) {
+            sv.fit()
+        } else {
+            Err(FitError::UnknownSatellite)
+        }
+    }
 }