X-Git-Url: https://i11git.iti.kit.edu/anon-gitweb/?p=Mitarbeiter%2FTim-Zeitz%2Fstud-rust-base.git;a=blobdiff_plain;f=src%2Ftime.rs;h=687f3e424a86d090431c335b5cfb196545bb5476;hp=30da0a204578347b16f1034a8fa0daf809fc6b1c;hb=cac08e302995e25c4b5d99fd98a616d1207bae54;hpb=c56a14307218fbb51ad188826a431cd034cce473

diff --git a/src/time.rs b/src/time.rs
index 30da0a2..687f3e4 100644
--- a/src/time.rs
+++ b/src/time.rs
@@ -1,19 +1,25 @@
-use time_crate as time;
+//! This module contains a few utilities to measure how long executing algorithms takes.
+//! It utilizes the `time` crate.
 
+/// This function will measure how long it takes to execute the given lambda,
+/// print the time and return the result of the lambda.
 pub fn report_time<Out, F: FnOnce() -> Out>(name: &str, f: F) -> Out {
     let start = time::now();
-    println!("starting {}", name);
+    eprintln!("starting {}", name);
     let res = f();
-    println!("done {} - took: {}", name, (time::now() - start));
+    eprintln!("done {} - took: {}", name, (time::now() - start));
     res
 }
 
+/// This function will measure how long it takes to execute the given lambda
+/// and return a tuple of the result of the lambda and a duration object.
 pub fn measure<Out, F: FnOnce() -> Out>(f: F) -> (Out, time::Duration) {
     let start = time::now();
     let res = f();
     (res, time::now() - start)
 }
 
+/// A struct to repeatedly measure the time passed since the timer was started
 #[derive(Debug)]
 pub struct Timer {
     start: time::Tm
@@ -26,18 +32,22 @@ impl Default for Timer {
 }
 
 impl Timer {
+    /// Create and start a new `Timer`
     pub fn new() -> Timer {
         Timer { start: time::now() }
     }
 
+    /// Reset the `Timer`
     pub fn restart(&mut self) {
         self.start = time::now();
     }
 
+    /// Print the passed time in ms since the timer was started
     pub fn report_passed_ms(&self) {
-        println!("{}ms", (time::now() - self.start).num_milliseconds());
+        eprintln!("{}ms", (time::now() - self.start).num_milliseconds());
     }
 
+    /// Return the number of ms passed since the timer was started as a `i64`
     pub fn get_passed_ms(&self) -> i64 {
         (time::now() - self.start).num_milliseconds()
     }