feat(api)!: use bon to convert structs into builder functions

Co-authored-by: KSXGitHub <11488886+KSXGitHub@users.noreply.github.com>

Author: Copilot

Cargo.lock

@@ -50,6 +50,7 @@ cli-completions = ["cli"]
 
 [dependencies]
 assert-cmp = "0.3.0"
+bon = "3.9.0"
 clap = { version = "4.5.46", optional = true }
 clap_complete = { version = "4.5.57", optional = true }
 clap-utilities = { version = "0.2.0", optional = true }

Cargo.toml

@@ -12,11 +12,13 @@ use crate::{
     status_board::GLOBAL_STATUS_BOARD,
     visualizer::{BarAlignment, ColumnWidthDistribution, Direction, Visualizer},
 };
+use bon::Builder;
 use pipe_trait::Pipe;
 use serde::Serialize;
 use std::{io::stdout, iter::once, path::PathBuf};
 
 /// The sub program of the main application.
+#[derive(Builder)]
 pub struct Sub<Size, SizeGetter, HardlinksHandler, Report>
 where
     Report: ParallelReporter<Size> + Sync,

src/app/sub.rs

@@ -7,6 +7,7 @@ use super::{
     size,
     tree_builder::{Info, TreeBuilder},
 };
+use bon::Builder;
 use pipe_trait::Pipe;
 use std::{
     fs::{read_dir, symlink_metadata},
@@ -27,16 +28,17 @@ use std::{
 ///     size::Bytes,
 ///     hardlink::HardlinkIgnorant,
 /// };
-/// let builder = FsTreeBuilder {
-///     root: std::env::current_dir().unwrap(),
-///     hardlinks_recorder: &HardlinkIgnorant,
-///     size_getter: GetApparentSize,
-///     reporter: &ErrorOnlyReporter::new(ErrorReport::SILENT),
-///     max_depth: 10,
-/// };
+/// let reporter = ErrorOnlyReporter::new(ErrorReport::SILENT);
+/// let builder = FsTreeBuilder::builder()
+///     .root(std::env::current_dir().unwrap())
+///     .hardlinks_recorder(&HardlinkIgnorant)
+///     .size_getter(GetApparentSize)
+///     .reporter(&reporter)
+///     .max_depth(10)
+///     .build();
 /// let data_tree: DataTree<OsStringDisplay, Bytes> = builder.into();
 /// ```
-#[derive(Debug)]
+#[derive(Debug, Builder)]
 pub struct FsTreeBuilder<'a, Size, SizeGetter, HardlinksRecorder, Report>
 where
     Report: Reporter<Size> + Sync + ?Sized,

src/fs_tree_builder.rs

@@ -3,10 +3,11 @@ pub mod info;
 pub use info::Info;
 
 use super::{data_tree::DataTree, size};
+use bon::Builder;
 use rayon::prelude::*;
 
 /// Collection of functions and starting points in order to build a [`DataTree`] with [`From`] or [`Into`].
-#[derive(Debug)]
+#[derive(Debug, Builder)]
 pub struct TreeBuilder<Path, Name, Size, GetInfo, JoinPath>
 where
     Path: Send + Sync,

src/tree_builder.rs

@@ -15,6 +15,7 @@ pub use proportion_bar::{ProportionBar, ProportionBarBlock};
 pub use tree::{TreeHorizontalSlice, TreeSkeletalComponent};
 
 use super::{data_tree::DataTree, size};
+use bon::Builder;
 use std::fmt::Display;
 
 /// Visualize a [`DataTree`].
@@ -32,17 +33,17 @@ use std::fmt::Display;
 /// # use parallel_disk_usage::visualizer::{Visualizer, Direction, BarAlignment, ColumnWidthDistribution};
 /// # fn _wrapper(create_data_tree: fn() -> DataTree<OsStringDisplay, Bytes>) {
 /// let data_tree: DataTree<OsStringDisplay, Bytes> = create_data_tree();
-/// let visualizer = Visualizer {
-///     data_tree: &data_tree,
-///     bytes_format: BytesFormat::MetricUnits,
-///     direction: Direction::BottomUp,
-///     bar_alignment: BarAlignment::Right,
-///     column_width_distribution: ColumnWidthDistribution::total(100),
-/// };
+/// let visualizer = Visualizer::builder()
+///     .data_tree(&data_tree)
+///     .bytes_format(BytesFormat::MetricUnits)
+///     .direction(Direction::BottomUp)
+///     .bar_alignment(BarAlignment::Right)
+///     .column_width_distribution(ColumnWidthDistribution::total(100))
+///     .build();
 /// println!("{visualizer}");
 /// # }
 /// ```
-#[derive(Debug)]
+#[derive(Debug, Builder)]
 pub struct Visualizer<'a, Name, Size>
 where
     Name: Display,