Replace 'summary' method with 'description', with detail level argument.

greatscottgadgets · Aug 5, 2024 · 4253aa3 · 4253aa3
1 parent 5e4f7e4
commit 4253aa3
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 15 deletions.
diff --git a/src/capture.rs b/src/capture.rs
@@ -1064,7 +1064,10 @@ pub trait ItemSource<Item> {
         -> Result<Item, Error>;
     fn item_children(&mut self, parent: Option<&Item>)
         -> Result<(CompletionStatus, u64), Error>;
-    fn summary(&mut self, item: &Item) -> Result<String, Error>;
+    fn description(&mut self,
+                   item: &Item,
+                   detail: bool)
+        -> Result<String, Error>;
     fn connectors(&mut self, item: &Item) -> Result<String, Error>;
     fn timestamp(&mut self, item: &Item) -> Result<Timestamp, Error>;
 }
@@ -1145,7 +1148,7 @@ impl ItemSource<TrafficItem> for CaptureReader {
         })
     }
 
-    fn summary(&mut self, item: &TrafficItem)
+    fn description(&mut self, item: &TrafficItem, _detail: bool)
         -> Result<String, Error>
     {
         use PID::*;
@@ -1588,7 +1591,7 @@ impl ItemSource<DeviceItem> for CaptureReader {
         Ok((completion, children as u64))
     }
 
-    fn summary(&mut self, item: &DeviceItem)
+    fn description(&mut self, item: &DeviceItem, _detail: bool)
         -> Result<String, Error>
     {
         use DeviceItem::*;
@@ -1692,7 +1695,7 @@ mod tests {
     fn summarize_item(cap: &mut CaptureReader, item: &TrafficItem, depth: usize)
         -> String
     {
-        let mut summary = cap.summary(item).unwrap();
+        let mut summary = cap.description(item, false).unwrap();
         let (_completion, num_children) =
             cap.item_children(Some(item)).unwrap();
         let child_ids = 0..num_children;

diff --git a/src/model/mod.rs b/src/model/mod.rs
@@ -36,7 +36,7 @@ pub trait GenericModel<Item> where Self: Sized {
                     expanded: bool)
         -> Result<(), Error>;
     fn update(&self) -> Result<bool, Error>;
-    fn summary(&self, item: &Item) -> String;
+    fn description(&self, item: &Item, detail: bool) -> String;
     fn timestamp(&self, item: &Item) -> u64;
     fn connectors(&self, item: &Item) -> String;
 }
@@ -75,10 +75,10 @@ impl GenericModel<TrafficItem> for TrafficModel {
         tree.update(self)
     }
 
-    fn summary(&self, item: &TrafficItem) -> String {
+    fn description(&self, item: &TrafficItem, detail: bool) -> String {
         let tree_opt = self.imp().tree.borrow();
         let tree = tree_opt.as_ref().unwrap();
-        tree.summary(item)
+        tree.description(item, detail)
     }
 
     fn timestamp(&self, item: &TrafficItem) -> u64 {
@@ -128,10 +128,10 @@ impl GenericModel<DeviceItem> for DeviceModel {
         tree.update(self)
     }
 
-    fn summary(&self, item: &DeviceItem) -> String {
+    fn description(&self, item: &DeviceItem, detail: bool) -> String {
         let tree_opt = self.imp().tree.borrow();
         let tree = tree_opt.as_ref().unwrap();
-        tree.summary(item)
+        tree.description(item, detail)
     }
 
     fn timestamp(&self, _item: &DeviceItem) -> u64 {

diff --git a/src/record_ui.rs b/src/record_ui.rs
@@ -212,7 +212,7 @@ impl Recording {
             .borrow()
             .item;
         self.capture
-            .summary(&item)
+            .description(&item, false)
             .expect("Failed to generate item summary")
     }
 

diff --git a/src/tree_list_model.rs b/src/tree_list_model.rs
@@ -773,7 +773,7 @@ where Item: 'static + Copy + Debug,
 
             if item_updated {
                 // The node's description may change.
-                let summary = cap.summary(&item_node.item)?;
+                let summary = cap.description(&item_node.item, false)?;
                 #[cfg(any(test, feature="record-ui-test"))]
                 if let Ok(position) = u32::try_from(position) {
                     let mut on_item_update = self.on_item_update.borrow_mut();
@@ -948,9 +948,9 @@ where Item: 'static + Copy + Debug,
         cap.timestamp(item).unwrap_or(0)
     }
 
-    pub fn summary(&self, item: &Item) -> String {
+    pub fn description(&self, item: &Item, detail: bool) -> String {
         let mut cap = self.capture.borrow_mut();
-        match cap.summary(item) {
+        match cap.description(item, detail) {
             Ok(string) => string,
             Err(e) => format!("Error: {e:?}")
         }

diff --git a/src/ui.rs b/src/ui.rs
@@ -599,7 +599,7 @@ fn create_view<Item, Model, RowData>(
         match row.node() {
             Ok(node_ref) => {
                 let node = node_ref.borrow();
-                let summary = bind_model.summary(&node.item);
+                let summary = bind_model.description(&node.item, false);
                 let connectors = bind_model.connectors(&node.item);
                 expander_wrapper.set_text(summary);
                 expander_wrapper.set_connectors(connectors);
@@ -748,7 +748,7 @@ pub fn reset_capture() -> Result<CaptureWriter, Error> {
                             match row.node() {
                                 Ok(node_ref) => {
                                     let node = node_ref.borrow();
-                                    traffic_model.summary(&node.item)
+                                    traffic_model.description(&node.item, true)
                                 },
                                 Err(msg) => String::from(msg)
                             }