Struct Args

#[non_exhaustive]
pub struct Args {

    pub files: Vec<PathBuf>,
    pub json_input: bool,
    pub json_output: bool,
    pub bytes_format: BytesFormat,
    pub deduplicate_hardlinks: bool,
    pub top_down: bool,
    pub align_right: bool,
    pub quantity: Quantity,
    pub max_depth: NonZeroU64,
    pub total_width: Option<usize>,
    pub column_width: Option<Vec<usize>>,
    pub min_ratio: Fraction,
    pub no_sort: bool,
    pub silent_errors: bool,
    pub progress: bool,
    pub threads: Threads,
    pub omit_json_shared_details: bool,
    pub omit_json_shared_summary: bool,
}

The CLI arguments.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

files: Vec<PathBuf>

List of files and/or directories.

json_input: bool

Read JSON data from stdin.

json_output: bool

Print JSON data instead of an ASCII chart.

bytes_format: BytesFormat

How to display the numbers of bytes.

deduplicate_hardlinks: bool

Detect and subtract the sizes of hardlinks from their parent directory totals.

top_down: bool

Print the tree top-down instead of bottom-up.

align_right: bool

Set the root of the bars to the right.

quantity: Quantity

Aspect of the files/directories to be measured.

max_depth: NonZeroU64

Maximum depth to display the data (must be greater than 0).

total_width: Option<usize>

Width of the visualization.

column_width: Option<Vec<usize>>

Maximum widths of the tree column and width of the bar column.

min_ratio: Fraction

Minimal size proportion required to appear.

no_sort: bool

Do not sort the branches in the tree.

silent_errors: bool

Prevent filesystem error messages from appearing in stderr.

progress: bool

Report progress being made at the expense of performance.

threads: Threads

Set the maximum number of threads to spawn. Could be either “auto”, “max”, or a number.

omit_json_shared_details: bool

Do not output .shared.details in the JSON output.

omit_json_shared_summary: bool

Do not output .shared.summary in the JSON output.

Implementations

impl Args

pub fn with_files(self, value: Vec<PathBuf>) -> Self

Sets the files field of this struct.

pub fn with_json_input(self, value: bool) -> Self

Sets the json_input field of this struct.

pub fn with_json_output(self, value: bool) -> Self

Sets the json_output field of this struct.

pub fn with_bytes_format(self, value: BytesFormat) -> Self

Sets the bytes_format field of this struct.

pub fn with_deduplicate_hardlinks(self, value: bool) -> Self

Sets the deduplicate_hardlinks field of this struct.

pub fn with_top_down(self, value: bool) -> Self

Sets the top_down field of this struct.

pub fn with_align_right(self, value: bool) -> Self

Sets the align_right field of this struct.

pub fn with_quantity(self, value: Quantity) -> Self

Sets the quantity field of this struct.

pub fn with_max_depth(self, value: NonZeroU64) -> Self

Sets the max_depth field of this struct.

pub fn with_total_width(self, value: Option<usize>) -> Self

Sets the total_width field of this struct.

pub fn with_column_width(self, value: Option<Vec<usize>>) -> Self

Sets the column_width field of this struct.

pub fn with_min_ratio(self, value: Fraction) -> Self

Sets the min_ratio field of this struct.

pub fn with_no_sort(self, value: bool) -> Self

Sets the no_sort field of this struct.

pub fn with_silent_errors(self, value: bool) -> Self

Sets the silent_errors field of this struct.

pub fn with_progress(self, value: bool) -> Self

Sets the progress field of this struct.

pub fn with_threads(self, value: Threads) -> Self

Sets the threads field of this struct.

pub fn with_omit_json_shared_details(self, value: bool) -> Self

Sets the omit_json_shared_details field of this struct.

pub fn with_omit_json_shared_summary(self, value: bool) -> Self

Sets the omit_json_shared_summary field of this struct.

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for Args

fn clone(&self) -> Args

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for Args

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Args

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Args

fn default() -> Self

Return Args { files: Default::default(), json_input: Default::default(), json_output: Default::default(), bytes_format: BytesFormat::MetricUnits, deduplicate_hardlinks: Default::default(), top_down: Default::default(), align_right: Default::default(), quantity: Quantity::DEFAULT, max_depth: 10.try_into().unwrap(), total_width: Default::default(), column_width: Default::default(), min_ratio: Default::default(), no_sort: Default::default(), silent_errors: Default::default(), progress: Default::default(), threads: Default::default(), omit_json_shared_details: Default::default(), omit_json_shared_summary: Default::default() }

impl FromArgMatches for Args

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Args

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.