Enum OutputFormat 

pub enum OutputFormat {
    Human,
    Json,
    JsonCompact,
    Quiet,
}

Output format for CLI commands.

Controls how command results are formatted and displayed to stdout. This is independent of logging (stderr) controlled by --log-level.

Examples

use sublime_cli_tools::output::OutputFormat;

let format = OutputFormat::Human;
assert!(!format.is_json());

let json_format = OutputFormat::Json;
assert!(json_format.is_json());

Variants

Human

Human-readable output with colors, tables, and formatting.

This is the default format for interactive use.

Json

Pretty-printed JSON output.

All command results are wrapped in a standard JSON structure with success, data, and error fields.

JsonCompact

Compact JSON output (single line, no whitespace).

Same structure as Json but minified for piping and processing.

Quiet

Minimal output mode.

Only essential information is displayed. Useful for scripting.

Implementations

impl OutputFormat

pub fn is_json(&self) -> bool

Returns true if this format is JSON (either pretty or compact).

Examples

use sublime_cli_tools::output::OutputFormat;

assert!(OutputFormat::Json.is_json());
assert!(OutputFormat::JsonCompact.is_json());
assert!(!OutputFormat::Human.is_json());

pub fn is_human(&self) -> bool

Returns true if this format is human-readable.

Examples

use sublime_cli_tools::output::OutputFormat;

assert!(OutputFormat::Human.is_human());
assert!(!OutputFormat::Json.is_human());

pub fn is_quiet(&self) -> bool

Returns true if this format is quiet mode.

Examples

use sublime_cli_tools::output::OutputFormat;

assert!(OutputFormat::Quiet.is_quiet());
assert!(!OutputFormat::Human.is_quiet());

Trait Implementations

impl Clone for OutputFormat

fn clone(&self) -> OutputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputFormat

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

Formats the value using the given formatter.

impl Default for OutputFormat

fn default() -> OutputFormat

Returns the “default value” for a type.

impl Display for OutputFormat

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

Formats the value using the given formatter.

impl From<OutputFormat> for OutputFormatArg

fn from(format: OutputFormat) -> Self

Converts to this type from the input type.

impl From<OutputFormatArg> for OutputFormat

fn from(arg: OutputFormatArg) -> Self

Converts to this type from the input type.

impl FromStr for OutputFormat

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for OutputFormat

fn eq(&self, other: &OutputFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for OutputFormat

impl Eq for OutputFormat

impl StructuralPartialEq for OutputFormat