Struct Formatter 

pub struct Formatter { /* private fields */ }

Formatter for CLI output

Handles both human-readable and JSON output formats based on configuration. When JSON mode is enabled, all output is strict JSON without colors or progress.

Implementations

impl Formatter

pub fn new(config: OutputConfig) -> Self

Create a new formatter with the given configuration

pub fn is_json(&self) -> bool

Check if JSON output mode is enabled

pub fn is_quiet(&self) -> bool

Check if quiet mode is enabled

pub fn colors_enabled(&self) -> bool

Check if colors are enabled

pub fn theme(&self) -> &Theme

Get the current theme

pub fn output_config(&self) -> OutputConfig

Get a clone of the output configuration

pub fn style_dir(&self, text: &str) -> String

Style a directory name (blue + bold)

pub fn style_file(&self, text: &str) -> String

Style a file name (default)

pub fn style_size(&self, text: &str) -> String

Style a file size (green)

pub fn style_date(&self, text: &str) -> String

Style a timestamp/date (dim)

pub fn style_key(&self, text: &str) -> String

Style a property key (cyan)

pub fn style_url(&self, text: &str) -> String

Style a URL/endpoint (cyan + underline)

pub fn style_name(&self, text: &str) -> String

Style an alias/bucket name (bold)

pub fn sanitize_text(&self, text: &str) -> String

pub fn style_tree_branch(&self, text: &str) -> String

Style tree branch characters (dim)

pub fn output<T: Serialize + Display>(&self, value: &T)

Output a value

In JSON mode, serializes the value to JSON. In human mode, uses the Display implementation.

pub fn success(&self, message: &str)

Output a success message

pub fn error(&self, message: &str)

Output an error message

Errors are always printed, even in quiet mode.

pub fn error_with_code(&self, code: ExitCode, message: &str)

Output an error message with an explicit exit code.

pub fn error_with_suggestion( &self, code: ExitCode, message: &str, suggestion: &str, )

Output an error message with an explicit exit code and recovery suggestion.

pub fn fail(&self, code: ExitCode, message: &str) -> ExitCode

Print an error and return the provided exit code.

pub fn fail_with_suggestion( &self, code: ExitCode, message: &str, suggestion: &str, ) -> ExitCode

Print an error with a recovery hint and return the provided exit code.

pub fn warning(&self, message: &str)

Output a warning message

pub fn json<T: Serialize>(&self, value: &T)

Output JSON directly

Used when you want to output a pre-built JSON structure.

pub fn json_line<T: Serialize>(&self, value: &T)

Output one compact JSON Lines record to stdout.

pub fn try_json_line<T: Serialize>(&self, value: &T) -> Result<()>

Write one compact JSON Lines record to stdout and report output failures.

pub fn json_line_error<T: Serialize>(&self, value: &T)

Output one compact JSON Lines error record to stderr.

pub fn json_error<T: Serialize>(&self, value: &T)

Output a pre-built JSON error record on stderr.

pub fn println(&self, message: &str)

Print a line of text (respects quiet mode)

pub fn try_println(&self, message: &str) -> Result<()>

Print a line to stdout and report output failures.

Trait Implementations

impl Clone for Formatter

fn clone(&self) -> Formatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Formatter

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

Formats the value using the given formatter.

impl Default for Formatter

fn default() -> Self

Returns the “default value” for a type.