Add 'name' and 'set_name' methods to trait

Byron · Byron · commit 94c4390af8cf · 2020-08-16T17:03:16.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## v9.0.0
+
+### Breaking
+
+* add `set_name(…)` and `name()` to `Progress` trait.
+
 ## v8.0.1 - Add missing trailing paranthesis in throughput display
 
 ## v8.0.0
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "prodash"
-version = "8.0.1"
+version = "9.0.0"
 authors = ["Sebastian Thiel <sebastian.thiel@icloud.com>"]
 description = "A dashboard for visualizing progress of asynchronous and possibly blocking tasks"
 edition = "2018"
diff --git a/src/progress/log.rs b/src/progress/log.rs
@@ -12,6 +12,7 @@ pub struct Log {
 }
 
 const EMIT_LOG_EVERY_S: f32 = 0.5;
+const SEP: &str = "::";
 
 impl Log {
     pub fn new(name: impl Into<String>, max_level: Option<usize>) -> Self {
@@ -32,7 +33,7 @@ impl Progress for Log {
 
     fn add_child(&mut self, name: impl Into<String>) -> Self::SubProgress {
         Log {
-            name: format!("{}::{}", self.name, Into::<String>::into(name)),
+            name: format!("{}{}{}", self.name, SEP, Into::<String>::into(name)),
             current_level: self.current_level + 1,
             max_level: self.max_level,
             step: 0,
@@ -87,6 +88,20 @@ impl Progress for Log {
         self.set(self.step + step)
     }
 
+    fn set_name(&mut self, name: impl Into<String>) {
+        let name = name.into();
+        self.name = self
+            .name
+            .split("::")
+            .next()
+            .map(|parent| format!("{}{}{}", parent.to_owned(), SEP, name))
+            .unwrap_or(name);
+    }
+
+    fn name(&self) -> Option<String> {
+        self.name.split(SEP).skip(1).next().map(ToOwned::to_owned)
+    }
+
     fn message(&mut self, level: MessageLevel, message: impl Into<String>) {
         let message: String = message.into();
         match level {
diff --git a/src/progress/utils.rs b/src/progress/utils.rs
@@ -19,6 +19,12 @@ impl Progress for Discard {
 
     fn inc_by(&mut self, _step: usize) {}
 
+    fn set_name(&mut self, _name: impl Into<String>) {}
+
+    fn name(&self) -> Option<String> {
+        None
+    }
+
     fn message(&mut self, _level: MessageLevel, _message: impl Into<String>) {}
 }
 
@@ -83,6 +89,20 @@ where
         }
     }
 
+    fn set_name(&mut self, name: impl Into<String>) {
+        match self {
+            Either::Left(l) => l.set_name(name),
+            Either::Right(r) => r.set_name(name),
+        }
+    }
+
+    fn name(&self) -> Option<String> {
+        match self {
+            Either::Left(l) => l.name(),
+            Either::Right(r) => r.name(),
+        }
+    }
+
     fn message(&mut self, level: MessageLevel, message: impl Into<String>) {
         match self {
             Either::Left(l) => l.message(level, message),
@@ -156,6 +176,14 @@ where
         self.0.inc_by(step)
     }
 
+    fn set_name(&mut self, name: impl Into<String>) {
+        self.0.set_name(name);
+    }
+
+    fn name(&self) -> Option<String> {
+        self.0.name()
+    }
+
     fn message(&mut self, level: MessageLevel, message: impl Into<String>) {
         self.0.message(level, message)
     }
@@ -202,6 +230,14 @@ impl<T: Progress> Progress for ThroughputOnDrop<T> {
         self.0.inc_by(step)
     }
 
+    fn set_name(&mut self, name: impl Into<String>) {
+        self.0.set_name(name)
+    }
+
+    fn name(&self) -> Option<String> {
+        self.0.name()
+    }
+
     fn message(&mut self, level: MessageLevel, message: impl Into<String>) {
         self.0.message(level, message)
     }
diff --git a/src/traits.rs b/src/traits.rs
@@ -53,6 +53,14 @@ pub trait Progress {
         self.inc_by(1)
     }
 
+    /// Set the name of the instance, altering the value given when crating it with `add_child(…)`
+    /// The progress is allowed to discard it.
+    fn set_name(&mut self, name: impl Into<String>);
+
+    /// Get the name of the instance as given when creating it with `add_child(…)`
+    /// The progress is allowed to not be named, thus there is no guarantee that a previously set names 'sticks'.
+    fn name(&self) -> Option<String>;
+
     /// Create a `message` of the given `level` and store it with the progress tree.
     ///
     /// Use this to provide additional,human-readable information about the progress
diff --git a/src/tree/item.rs b/src/tree/item.rs
@@ -259,6 +259,14 @@ impl crate::Progress for Item {
         self.inc_by(step)
     }
 
+    fn set_name(&mut self, name: impl Into<String>) {
+        Item::set_name(self, name)
+    }
+
+    fn name(&self) -> Option<String> {
+        Item::name(self)
+    }
+
     fn message(&mut self, level: MessageLevel, message: impl Into<String>) {
         Item::message(self, level, message)
     }

Original file line number	Diff line number	Diff line change
`@@ -259,6 +259,14 @@ impl crate::Progress for Item {`
`259`	`259`	`self.inc_by(step)`
`260`	`260`	`}`
`261`	`261`
	`262`	`+ fn set_name(&mut self, name: impl Into<String>) {`
	`263`	`+ Item::set_name(self, name)`
	`264`	`+ }`
	`265`	`+`
	`266`	`+ fn name(&self) -> Option<String> {`
	`267`	`+ Item::name(self)`
	`268`	`+ }`
	`269`	`+`
`262`	`270`	`fn message(&mut self, level: MessageLevel, message: impl Into<String>) {`
`263`	`271`	`Item::message(self, level, message)`
`264`	`272`	`}`