Struct Args 

pub struct Args {

    pub paths: Vec<PathBuf>,
    pub format: Option<FormatChoice>,
    pub table: Option<String>,
    pub hive: bool,
    pub compression: Option<CompressionFormat>,
    pub dict: Vec<PathBuf>,
    pub follow: bool,
    pub tee: Option<PathBuf>,
    pub tee_raw: bool,
    pub force: bool,
    pub hex: bool,
    pub hex_width: Option<u16>,
    pub view: Option<String>,
    pub temp_dir: Option<PathBuf>,
    pub delimiter: Option<u8>,
    pub no_header: bool,
    pub header_rows: Vec<u64>,
    pub footer_rows: Option<usize>,
    pub skip_rows: Option<usize>,
    pub skip_lines: Option<usize>,
    pub comment: Option<String>,
    pub skip_initial_space: Option<bool>,
    pub null: Vec<String>,
    pub infer_types: Option<InferTypes>,
    pub infer_rows: Option<usize>,
    pub ignore_errors: Option<bool>,
    pub row_numbers: Option<bool>,
    pub number_format: Option<String>,
    pub mouse: Option<bool>,
    pub sample_rows: Option<usize>,
    pub config: Vec<Override>,
    pub log_file: Option<PathBuf>,
    pub log_level: Option<String>,
    pub command: Option<Command>,
}

Command-line arguments for datui.

A flag exists when one invocation needs it: what to open, how to read this file, what to do at start. Everything else is config, set for one run with -c. A flag that sets a config key takes its help from the option registry.

Fields

paths: Vec<PathBuf>

Files, directories, globs or URLs to open; files of the same shape open as one table. - reads standard input, as does no PATH when data is piped in. With no PATH and nothing piped in, datui opens the home screen

format: Option<FormatChoice>

table: Option<String>

hive: bool

Read a glob as one partitioned table, or force partition columns on a directory whose layout does not say so. Ignored for a single file

compression: Option<CompressionFormat>

Compression, when the extension does not say: gzip, zstd, bzip2 or xz

dict: Vec<PathBuf>

A dictionary to decode with, ahead of those on the format search path: QuickFIX XML (.xml) for FIX logs, DBC (.dbc) for CAN logs, or TOML with kind = “fix” or “dbc”. Repeatable

follow: bool

Follow the file as it grows, as tail -f does: a local CSV, TSV, PSV or NDJSON file or Arrow IPC stream, or standard input (-). t pauses and resumes; Esc stops

tee: Option<PathBuf>

Record standard input to FILE while viewing it. With -, pass it through to standard output, as tee does, while drawing on the terminal

tee_raw: bool

With –tee: write FILE exactly as the bytes arrived. Without it, sizes a stream left blank in its header are filled in when it ends

force: bool

With –tee: replace FILE if it exists

hex: bool

Open in the hex view, whatever the file holds

hex_width: Option<u16>

Bytes per row in the hex view, so records line up (default: 8, 16, 32 or 64, as many as fit)

view: Option<String>

Apply a saved view by name once the data is on screen

temp_dir: Option<PathBuf>

delimiter: Option<u8>

Column separator: one character, tab, \t or a code such as 0x1f (default: , for .csv, tab for .tsv, | for .psv)

no_header: bool

Read the first row as data; columns are named column_1, column_2, …

header_rows: Vec<u64>

The line holding the header, or several lines separated by commas, counted from 1 before anything is skipped. Several lines are joined per column ([csv] header_join), and the data starts after the last

footer_rows: Option<usize>

Skip this many rows at the end, such as a footer. Reads the whole file to count rows

skip_rows: Option<usize>

Skip this many rows before the header (with –header-rows, after it). Quote-aware, unlike –skip-lines

skip_lines: Option<usize>

Skip this many raw lines at the start. Every newline ends a line, even one inside quotes

comment: Option<String>

skip_initial_space: Option<bool>

null: Vec<String>

infer_types: Option<InferTypes>

infer_rows: Option<usize>

ignore_errors: Option<bool>

row_numbers: Option<bool>

number_format: Option<String>

mouse: Option<bool>

sample_rows: Option<usize>

config: Vec<Override>

Set a config key for this run, written as in the file: -c display.row_numbers=true. Repeatable; the key’s own flag, where it has one, still wins. datui config keys lists the keys

log_file: Option<PathBuf>

log_level: Option<String>

command: Option<Command>

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<(), Error>

Formats the value using the given formatter.

impl From<&Args> for OpenOptions

fn from(args: &Args) -> Self

Converts to this type from the input type.

impl FromArgMatches for Args

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Args, 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.