Add duration format to battery block

Author: bim9262

src/blocks/battery.rs

@@ -28,9 +28,11 @@
 //! -------------|-------------------------------------------------------------------------|-------------------|-----
 //! `icon`       | Icon based on battery's state                                           | Icon   | -
 //! `percentage` | Battery level, in percent                                               | Number | Percents
-//! `time`       | Time remaining until (dis)charge is complete. Presented only if battery's status is (dis)charging. | String | -
+//! `time`       | Time remaining until (dis)charge is complete. Presented only if battery's status is (dis)charging. | Duration or String *DEPRECATED* | -
 //! `power`      | Power consumption by the battery or from the power supply when charging | String or Float   | Watts
 //!
+//!  formatting `time` with the `str` formatter has been deprecated in favor of the `dur` formatter.
+//!
 //! # Examples
 //!
 //! Basic usage:
@@ -44,7 +46,7 @@
 //! ```toml
 //! [[block]]
 //! block = "battery"
-//! format = " $percentage {$time |}"
+//! format = " $percentage {$time.dur(hms:true, min_unit:m) |}"
 //! device = "DisplayDevice"
 //! driver = "upower"
 //! ```
@@ -164,11 +166,14 @@ pub async fn run(config: &Config, api: &CommonApi) -> Result<()> {
                 info.time_remaining.map(|t| {
                     values.insert(
                         "time".into(),
-                        Value::text(format!(
-                            "{}:{:02}",
-                            (t / 3600.) as i32,
-                            (t % 3600. / 60.) as i32
-                        )),
+                        Value::duration_with_str(
+                            Duration::from_secs(t as u64),
+                            Some(format!(
+                                "{}:{:02}",
+                                (t / 3600.) as i32,
+                                (t % 3600. / 60.) as i32
+                            )),
+                        ),
                     )
                 });
 

src/formatting/formatter/duration.rs

@@ -196,7 +196,7 @@ impl DurationFormatter {
 impl Formatter for DurationFormatter {
     fn format(&self, val: &Value, _config: &SharedConfig) -> Result<String, FormatError> {
         match val {
-            Value::Duration(duration) => {
+            Value::Duration(duration, _) => {
                 let mut v = self.get_time_parts(duration.as_millis());
 
                 if self.round_up {
@@ -277,7 +277,7 @@ mod tests {
                     .expect("unit must be one of \"y\", \"w\", \"d\", \"h\", \"m\", \"s\", or \"ms\"")]
                     as u64);
             )*
-           Value::Duration(std::time::Duration::from_millis(ms))
+           Value::Duration(std::time::Duration::from_millis(ms), None)
         }};
     }
 

src/formatting/formatter/str.rs

@@ -83,7 +83,7 @@ impl StrFormatter {
 impl Formatter for StrFormatter {
     fn format(&self, val: &Value, config: &SharedConfig) -> Result<String, FormatError> {
         match val {
-            Value::Text(text) => {
+            Value::Text(text) | Value::Duration(_, Some(text)) => {
                 let text: Vec<&str> = text.graphemes(true).collect();
                 let width = text.len();
                 Ok(match (self.rot_interval_ms, self.init_time) {

src/formatting/value.rs

@@ -19,7 +19,7 @@ pub enum ValueInner {
     Icon(Cow<'static, str>, Option<f64>),
     Number { val: f64, unit: Unit },
     Datetime(DateTime<Utc>, Option<Tz>),
-    Duration(Duration),
+    Duration(Duration, Option<String>),
     Flag,
 }
 
@@ -71,7 +71,11 @@ impl Value {
     }
 
     pub fn duration(duration: Duration) -> Self {
-        Self::new(ValueInner::Duration(duration))
+        Self::new(ValueInner::Duration(duration, None))
+    }
+
+    pub fn duration_with_str(duration: Duration, duration_string: Option<String>) -> Self {
+        Self::new(ValueInner::Duration(duration, duration_string))
     }
 
     pub fn icon<S>(name: S) -> Self