Skip to main content

Module config

Module config 

Source

Re-exports§

pub use crate::home::catalog::is_object_store_dataset;

Modules§

config_command
datui config: write the default file, list the files read, list every key.
themes
Named themes: the two built in, and every *.toml in the config directory’s themes/, each a set of theme.colors slots named by its file. theme.dark and theme.light pick one per mode; theme.colors lies over whichever is in use.

Structs§

AnalysisConfig
[analysis]: Analysis, Data Quality and charts.
AppConfig
Complete application configuration
ByteSize
A size in bytes, written with its unit in config: max_buffered = "512MiB".
ChartConfig
[chart]: charts exported to a file.
ClipboardConfig
[clipboard]: how the copy dialog reaches the system clipboard.
CloudConfig
CloudConnectionConfig
One store in [[cloud.connections]]: names and pointers only; secrets come from the environment variables named here.
ColorConfig
Color configuration for the application theme: one slot per role, each a name ("cyan", "default"), "#rrggbb" or "indexed(N)". The option registry documents every slot and holds its dark and light defaults.
ColorParser
Color parser with terminal capability detection
ConfigLayer
One config file’s settings as written. Partial, so a later file can set a value back to its default and an omitted key changes nothing; AppConfig::from_layers fills defaults once after merging.
ConfigManager
Manages config directory and config file operations
CsvConfig
[csv]: CSV, TSV and PSV, and the dialect a delimited spec writes with these keys.
DatasetAccess
How a catalog dataset’s URL in an object store is read, when it says.
DisplayConfig
FormatsConfig
[formats]: where format specs and dictionaries are found.
GlyphsConfig
[glyphs]: per-slot overrides over the Unicode set, for fonts with more than the coverage floor. Keys are glyphs.rs slot names; values keep the replaced glyph’s width. The ASCII set is never overridden. Layered like every section.
HomeConfig
Where datui looks for datasets on home: a short list of places, PATH-shaped; it records nothing about what it finds there.
HttpConfig
[http]: what every request datui makes says about it.
Interval
A duration written with its unit in config: follow_interval = "250ms".
LimitsConfig
[limits]: the most of a file some readers take in. Each note or error that says a cap was reached names its key here.
LogConfig
[log]: the log file and how much it says.
NumberFormatTable
Long-form number formatting options; unset fields take the value of the preset named by grouping (or the default).
PerformanceConfig
QueryConfig
ReadConfig
[read]: how files are read.
SearchConfig
Recursive search under the working directory, driven by home’s filter: one background walk on first typing, then each keystroke scores its results off the UI thread. These limits bound the walk and the list.
Theme
Theme containing parsed colors ready for use
ThemeConfig
ViewsConfig
[views]: saved views.

Enums§

CatalogRef
One catalogs entry: a path, or a table giving a file an id and label of its own.
CellPadding
Spacing between the main table’s columns, frozen and scrolling alike: a density by name, or a count of cells.
CloudDiscover
[cloud] discover: true or "all", false or "none", or a list of kinds. "all" and "none" are words, not list members.
DatasetAuth
Density
The named spacings.
InferTypes
[read] infer_types: every string column, none, or the columns named.
LayerSource
Where a layer of the configuration came from.
NumberFormatConfig
Number display settings: a preset name (number_format = "thousands") or a [display.number_format] table.
ParquetSchema
[read] parquet_schema.
QueryMode
The language the command line runs a query in.
RowNumbers
Whether # shows row numbers when a file opens: for text and logs ("auto"), or for every format or none.
ThemeMode
Which built-in color defaults to start from. Chrome colors (header fills, striping, borders) must sit near the background without matching it, which no ANSI color expresses, so they are fixed per set.

Constants§

CHART_SERIES_SLOTS
The theme’s chart series slots, chart_1 to chart_10.
CLOUD_DISCOVER_KINDS
The kinds of source [cloud] discover can name.
DEFAULT_ANALYSIS_SAMPLE_ROWS
Rows an analysis samples by default: stable distributions and correlations to two decimals, read in seconds.
DEFAULT_CHART_ROW_LIMIT
Default maximum rows used for chart data when not overridden by config or UI.
DEFAULT_QUALITY_LOCAL_COPY
Default for analysis.quality_local_copy: 2 GiB.
DEFAULT_SEARCH_SKIP
Directories that are never data and always expensive. Hidden ones are skipped already; these are the visible offenders, full of openable .json.
MAX_CHART_ROW_LIMIT
Maximum chart row limit (Polars slice takes u32).
S3_ENDPOINT_VARS
The variables naming an S3 endpoint, in lookup order: service-specific, general (as AWS SDKs read them), then AWS_ENDPOINT (what object_store accepts).

Functions§

cell_cursor_style
Style of the column cursor’s header and of the current cell: the cell_cursor tint in bold, or reversed video where the tint would not show, so the cell is marked on any terminal.
column_cursor_style
Style of the column cursor’s cells: the column_cursor tint, or nothing where the tint would not show; the header and the current cell still mark the column there.
expand_config_path
Expand a leading ~ and any $VAR / ${VAR} in a config path; unset variables expand to nothing, as in a shell.
expand_home
path with a leading ~ expanded, nothing else: for command-line paths, which cmd, older PowerShell and quoting pass through with ~ (a $ was already expanded and is part of a name). A path that exists as typed (a file named ~) is kept.
is_valid_source_id
Whether id can name a source: lowercase letters, digits and -, starting with a letter or digit, at most 40 characters (it goes into URLs and cache keys).
rgb_to_256_color
The nearest xterm 256-color palette index to an RGB color.
rgb_to_basic_ansi
Convert RGB to nearest basic ANSI color (8 colors)
tint_shows
Whether a tint can be told from the terminal’s own background: a 16-color terminal turns the default tints into black or white, and NO_COLOR into none.
way_out
The line after a config mistake saying how to proceed: a missing import is skipped, and datui config init writes a root file only where there is none.