Struct FormatArgs 

pub struct FormatArgs {
    pub format: Format,
    pub json: bool,
    pub lines: bool,
    pub columns: Option<String>,
    pub no_header: bool,
    pub header_only: bool,
}

Output format selection for vre data commands.

Flattened into each of the six vre leaf Args structs. Provides --format, -j/--json, and -l/--lines as parallel selection paths.

Precedence (resolved by FormatArgs::resolve): -j > -l > --format. No conflicts_with is used — clap treats default_value_t as “implicitly set”, which would make valid calls like dsp vre project list -j collide with the prose default. The helper-method precedence is simpler and correct.

See ADR-0003 for the output format specification and the design-decisions section of the 003 plan for why this is per-leaf rather than global.

Fields

format: Format

Output format (default: prose).

json: bool

Shortcut for –format=json.

lines: bool

Shortcut for –format=lines.

columns: Option<String>

Output columns for tabular formats (csv, tsv, lines): comma-separated list that selects and reorders columns. Valid names are listed in the Columns line below. Duplicates are rejected.

no_header: bool

Omit the csv/tsv header row, e.g. appending rows to an existing file.

header_only: bool

Emit only the csv/tsv header row, no data rows. Note: the command still contacts the server.

Implementations

impl FormatArgs

pub fn resolve(&self) -> Format

Resolve the effective format. Precedence: -j > -l > --format.

pub fn table_options(&self, format: Format) -> Result<TableOptions, Diagnostic>

Validate and resolve tabular options from the CLI flags.

format must be the resolved format (call FormatArgs::resolve first — never pass self.format, which is always Prose when -j/-l are used).

Validation rules

• --columns is only valid with csv, tsv, or lines output. Any other format → Diagnostic::Usage.
• --no-header / --header-only are only valid with csv or tsv. lines has no header concept. Any other format → Diagnostic::Usage.
• --columns value: the string must be non-empty; each comma-separated token must be non-blank (no a,,b); no duplicates allowed. Unknown column names are validated later by the engine (which knows the per-noun set).

Returns a TableOptions whose columns field is guaranteed to be syntactically valid (non-empty Some(Vec) with no blank entries and no duplicates), or None if --columns was not supplied.

Trait Implementations

impl Args for FormatArgs

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 Debug for FormatArgs

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

Formats the value using the given formatter.

impl FromArgMatches for FormatArgs

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.