Skip to main content

Args

Struct Args 

Source
pub struct Args {
Show 32 fields pub paths: Vec<PathBuf>, pub skip_lines: Option<usize>, pub skip_rows: Option<usize>, pub no_header: Option<bool>, pub delimiter: Option<u8>, pub null_value: Vec<String>, pub compression: Option<CompressionFormat>, pub format: Option<FileFormat>, pub debug: bool, pub hive: bool, pub single_spine_schema: Option<bool>, pub parse_dates: Option<bool>, pub decompress_in_memory: Option<bool>, pub temp_dir: Option<PathBuf>, pub excel_sheet: Option<String>, pub clear_cache: bool, pub template: Option<String>, pub remove_templates: bool, pub sampling_threshold: Option<usize>, pub polars_streaming: Option<bool>, pub workaround_pivot_date_index: Option<bool>, pub pages_lookahead: Option<usize>, pub pages_lookback: Option<usize>, pub row_numbers: bool, pub row_start_index: Option<usize>, pub column_colors: Option<bool>, pub generate_config: bool, pub force: bool, pub s3_endpoint_url: Option<String>, pub s3_access_key_id: Option<String>, pub s3_secret_access_key: Option<String>, pub s3_region: Option<String>,
}
Expand description

Command-line arguments for datui

Fields§

§paths: Vec<PathBuf>

Path(s) to the data file(s) to open. Multiple files of the same format are concatenated into one table (not required with –generate-config, –clear-cache, or –remove-templates)

§skip_lines: Option<usize>

Skip this many lines when reading a file

§skip_rows: Option<usize>

Skip this many rows when reading a file

§no_header: Option<bool>

Specify that the file has no header

§delimiter: Option<u8>

Specify the delimiter to use when reading a delimited text file

§null_value: Vec<String>

Treat these values as null when reading CSV. Use once per value; no “=” means all columns, COL=VAL means column COL only (first “=” separates column from value). Example: –null-value NA –null-value amount=

§compression: Option<CompressionFormat>

Specify the compression format explicitly (gzip, zstd, bzip2, xz) If not specified, compression is auto-detected from file extension.

§format: Option<FileFormat>

Force file format (parquet, csv, tsv, psv, json, jsonl, arrow, avro, orc, excel). By default format is auto-detected from the file extension. Use this for URLs or paths without an extension.

§debug: bool

Enable debug mode to show operational information

§hive: bool

Enable Hive-style partitioning for directory or glob paths; ignored for a single file

§single_spine_schema: Option<bool>

Infer Hive/partitioned Parquet schema from one file for faster load (default: true). Set to false to use full schema scan.

§parse_dates: Option<bool>

Try to parse CSV string columns as dates (e.g. YYYY-MM-DD, ISO datetime). Default: true

§decompress_in_memory: Option<bool>

Decompress into memory. Default: decompress to temp file and use lazy scan

§temp_dir: Option<PathBuf>

Directory for decompression temp files (default: system temp, e.g. TMPDIR)

§excel_sheet: Option<String>

Excel sheet to load: 0-based index (e.g. 0) or sheet name (e.g. “Sales”)

§clear_cache: bool

Clear all cache data and exit

§template: Option<String>

Apply a template by name when starting the application

§remove_templates: bool

Remove all templates and exit

§sampling_threshold: Option<usize>

When set, datasets with this many or more rows are sampled for analysis (faster, less memory). Overrides config [performance] sampling_threshold. Use 0 to disable sampling (full dataset) for this run. When omitted, config or full-dataset mode is used.

§polars_streaming: Option<bool>

Use Polars streaming engine for LazyFrame collect when available (default: true). Set to false to disable.

§workaround_pivot_date_index: Option<bool>

Apply workaround for Polars 0.52 pivot with Date/Datetime index (default: true). Set to false to test without it.

§pages_lookahead: Option<usize>

Number of pages to buffer ahead of the visible area (default: 3) Larger values provide smoother scrolling but use more memory

§pages_lookback: Option<usize>

Number of pages to buffer behind the visible area (default: 3) Larger values provide smoother scrolling but use more memory

§row_numbers: bool

Display row numbers on the left side of the table

§row_start_index: Option<usize>

Starting index for row numbers (default: 1)

§column_colors: Option<bool>

Colorize main table cells by column type (default: true). Set to false to disable.

§generate_config: bool

Generate default configuration file at ~/.config/datui/config.toml

§force: bool

Force overwrite existing config file when using –generate-config

§s3_endpoint_url: Option<String>

S3-compatible endpoint URL (overrides config and AWS_ENDPOINT_URL). Example: http://localhost:9000

§s3_access_key_id: Option<String>

S3 access key (overrides config and AWS_ACCESS_KEY_ID)

§s3_secret_access_key: Option<String>

S3 secret key (overrides config and AWS_SECRET_ACCESS_KEY)

§s3_region: Option<String>

S3 region (overrides config and AWS_REGION). Example: us-east-1

Trait Implementations§

Source§

impl Args for Args

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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 Read more
Source§

impl CommandFactory for Args

Source§

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more
Source§

impl Debug for Args

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Args

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Parser for Args

Source§

fn parse() -> Self

Parse from std::env::args_os(), exit on error.
Source§

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.
Source§

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.
Source§

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.
Source§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error. Read more
Source§

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.

Auto Trait Implementations§

§

impl Freeze for Args

§

impl RefUnwindSafe for Args

§

impl Send for Args

§

impl Sync for Args

§

impl Unpin for Args

§

impl UnwindSafe for Args

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.