Struct OutputArgs 

pub struct OutputArgs {
    pub format: Option<OutputFormat>,
    pub json: bool,
    pub jsonl: bool,
    pub text: bool,
}

Shared output format arguments for commands that produce formatted output.

This group provides consistent format selection across commands with automatic TTY detection for sensible defaults.

Default Behavior

When no format is explicitly specified:

• Interactive terminal: Text (human-readable)
• Piped/redirected output: Json (machine-readable)

Usage

Flatten into command structs:

#[derive(Args)]
struct SearchArgs {
    #[command(flatten)]
    output: OutputArgs,
    // ... other args
}

Then resolve to an OutputFormat:

let format = args.output.resolve();

Fields

format: Option<OutputFormat>

Output format (text, json, jsonl, raw).

Defaults to text for terminals, json for pipes.

json: bool

Output as JSON (shorthand for –format json).

jsonl: bool

Output as JSON Lines (shorthand for –format jsonl).

text: bool

Output as plain text (shorthand for –format text).

Implementations

impl OutputArgs

pub const fn with_format(format: OutputFormat) -> Self

Create output args with a specific format.

pub fn resolve(&self) -> OutputFormat

Resolve the output arguments to a concrete format.

Priority order:

1. Shorthand flags (–json, –jsonl, –text)
2. Explicit –format flag
3. Automatic TTY detection

pub const fn is_explicit(&self) -> bool

Check if any format was explicitly specified.

Trait Implementations

impl Args for OutputArgs

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 OutputArgs

fn clone(&self) -> OutputArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputArgs

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

Formats the value using the given formatter.

impl Default for OutputArgs

fn default() -> OutputArgs

Returns the “default value” for a type.

impl FromArgMatches for OutputArgs

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 PartialEq for OutputArgs

fn eq(&self, other: &OutputArgs) -> 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 Eq for OutputArgs

impl StructuralPartialEq for OutputArgs