feat(api)!: rename UnitAndTree to JsonDataBody

Author: KSXGitHub

src/app.rs

@@ -7,7 +7,7 @@ use crate::{
     bytes_format::BytesFormat,
     get_size::{GetApparentSize, GetSize},
     hook,
-    json_data::{JsonData, UnitAndTree},
+    json_data::{JsonData, JsonDataBody},
     reporter::{ErrorOnlyReporter, ErrorReport, ProgressAndErrorReporter, ProgressReport},
     runtime_error::RuntimeError,
     size,
@@ -64,10 +64,10 @@ impl App {
             let direction = Direction::from_top_down(top_down);
             let bar_alignment = BarAlignment::from_align_right(align_right);
 
-            let unit_and_tree = stdin()
+            let body = stdin()
                 .pipe(serde_json::from_reader::<_, JsonData>)
                 .map_err(RuntimeError::DeserializationFailure)?
-                .unit_and_tree;
+                .body;
 
             macro_rules! visualize {
                 ($reflection:expr, $bytes_format: expr) => {{
@@ -85,9 +85,9 @@ impl App {
                 }};
             }
 
-            let visualization = match unit_and_tree {
-                UnitAndTree::Bytes(tree) => visualize!(tree.tree, bytes_format),
-                UnitAndTree::Blocks(tree) => visualize!(tree.tree, ()),
+            let visualization = match body {
+                JsonDataBody::Bytes(tree) => visualize!(tree.tree, bytes_format),
+                JsonDataBody::Blocks(tree) => visualize!(tree.tree, ()),
             };
 
             print!("{visualization}"); // it already ends with "\n", println! isn't needed here.

src/app/sub.rs

@@ -5,7 +5,7 @@ use crate::{
     get_size::GetSize,
     hardlink::HardlinkListReflection,
     hook,
-    json_data::{BinaryVersion, JsonData, JsonTree, SchemaVersion, UnitAndTree},
+    json_data::{BinaryVersion, JsonData, JsonDataBody, JsonTree, SchemaVersion},
     os_string_display::OsStringDisplay,
     reporter::ParallelReporter,
     runtime_error::RuntimeError,
@@ -24,7 +24,7 @@ where
     Size: size::Size + Into<u64> + Serialize + Send + Sync,
     SizeGetter: GetSize<Size = Size> + Copy + Sync,
     Hook: hook::Hook<Size, Report> + DeduplicateHardlinkSizes<Size> + Copy + Sync,
-    JsonTree<Size>: Into<UnitAndTree>,
+    JsonTree<Size>: Into<JsonDataBody>,
 {
     /// List of files and/or directories.
     pub files: Vec<PathBuf>,
@@ -60,7 +60,7 @@ where
     Report: ParallelReporter<Size> + Sync,
     SizeGetter: GetSize<Size = Size> + Copy + Sync,
     Hook: hook::Hook<Size, Report> + DeduplicateHardlinkSizes<Size> + Copy + Sync,
-    JsonTree<Size>: Into<UnitAndTree>,
+    JsonTree<Size>: Into<JsonDataBody>,
 {
     /// Run the sub program.
     pub fn run(self) -> Result<(), RuntimeError> {
@@ -154,7 +154,7 @@ where
             let json_data = JsonData {
                 schema_version: SchemaVersion,
                 binary_version: Some(BinaryVersion::current()),
-                unit_and_tree: json_tree.into(),
+                body: json_tree.into(),
             };
             return serde_json::to_writer(stdout(), &json_data)
                 .map_err(RuntimeError::SerializationFailure);

src/json_data.rs

@@ -14,7 +14,7 @@ use derive_more::{Deref, DerefMut, From, TryInto};
 #[cfg(feature = "json")]
 use serde::{Deserialize, Serialize};
 
-/// The `"tree"` field of [`JsonData`].
+/// The `"tree"` field and the `"shared-inodes"` field of [`JsonData`].
 #[derive(Debug, Clone, Deref, DerefMut)]
 #[cfg_attr(feature = "json", derive(Deserialize, Serialize))]
 #[cfg_attr(feature = "json", serde(rename_all = "kebab-case"))]
@@ -28,12 +28,12 @@ pub struct JsonTree<Size: size::Size> {
     pub shared_inodes: Option<HardlinkListReflection<Size>>,
 }
 
-/// The `"unit"` field and the `"tree"` field of [`JsonData`].
+/// The `"unit"` field, the `"tree"` field, and the `"shared-inodes"` field of [`JsonData`].
 #[derive(Debug, Clone, From, TryInto)]
 #[cfg_attr(feature = "json", derive(Deserialize, Serialize))]
 #[cfg_attr(feature = "json", serde(tag = "unit"))]
 #[cfg_attr(feature = "json", serde(rename_all = "kebab-case"))]
-pub enum UnitAndTree {
+pub enum JsonDataBody {
     /// Tree where size is [bytes](Bytes).
     Bytes(JsonTree<Bytes>),
     /// Tree where size is [blocks](Blocks).
@@ -51,7 +51,7 @@ pub struct JsonData {
     /// The `"pdu"` field.
     #[cfg_attr(feature = "json", serde(rename = "pdu"))]
     pub binary_version: Option<BinaryVersion>,
-    /// The `"unit"` field and the `"tree"` field.
+    /// The `"unit"` field, the `"tree"` field, and the `"shared-inodes"` field.
     #[cfg_attr(feature = "json", serde(flatten))]
-    pub unit_and_tree: UnitAndTree,
+    pub body: JsonDataBody,
 }

tests/deduplicate_hardlinks.rs

@@ -7,7 +7,7 @@ pub use _utils::*;
 use command_extra::CommandExtra;
 use parallel_disk_usage::{
     data_tree::Reflection,
-    json_data::{JsonData, UnitAndTree},
+    json_data::{JsonData, JsonDataBody},
     size::Bytes,
 };
 use pipe_trait::Pipe;
@@ -42,8 +42,8 @@ fn deduplicate_multiple_hardlinks_to_a_single_file() {
         .pipe_as_ref(serde_json::from_str::<JsonData>)
         .expect("parse stdout as JsonData");
 
-    let UnitAndTree::Bytes(tree) = &json.unit_and_tree else {
-        panic!("expecting Bytes but got {:?}", &json.unit_and_tree);
+    let JsonDataBody::Bytes(tree) = &json.body else {
+        panic!("expecting Bytes but got {:?}", &json.body);
     };
 
     let file_size = workspace
@@ -96,9 +96,9 @@ fn do_not_deduplicate_multiple_hardlinks_to_a_single_file() {
         .pipe_as_ref(serde_json::from_str::<JsonData>)
         .expect("parse stdout as JsonData");
 
-    let actual_size = match &json.unit_and_tree {
-        UnitAndTree::Blocks(_) => panic!("expecting Bytes, but got {:?}", &json.unit_and_tree),
-        UnitAndTree::Bytes(tree) => tree.size,
+    let actual_size = match &json.body {
+        JsonDataBody::Blocks(_) => panic!("expecting Bytes, but got {:?}", &json.body),
+        JsonDataBody::Bytes(tree) => tree.size,
     };
 
     let expected_size = workspace

tests/json.rs

@@ -74,7 +74,7 @@ fn json_output() {
         .pipe(stdout_text)
         .pipe_as_ref(serde_json::from_str::<JsonData>)
         .expect("parse stdout as JsonData")
-        .unit_and_tree
+        .body
         .pipe(TryInto::<SampleJsonTree>::try_into)
         .expect("extract reflection")
         .tree
@@ -106,7 +106,7 @@ fn json_input() {
     let json_data = JsonData {
         schema_version: SchemaVersion,
         binary_version: None,
-        unit_and_tree: json_tree.into(),
+        body: json_tree.into(),
     };
     let json = serde_json::to_string_pretty(&json_data).expect("convert sample tree to JSON");
     eprintln!("JSON: {json}\n");