Skip to main content

Module config

Module config 

Source

Re-exports§

pub use crate::catalog::is_object_store_dataset;

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: a secret comes from the environment variable named here, never from the config file itself.
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: the keys it sets and nothing else.
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 laid over the Unicode set, so a font that has more than the coverage floor gets to use it — ☁ back for the object-store mark, a Nerd Font icon for a checkbox. Keys are the slot names in glyphs.rs; values keep the display width of the glyph they replace. Overrides never touch the ASCII set, which stays the tested floor. Layered like every section: defaults, then each import, then the user’s file.
HomeConfig
Where datui looks for datasets on the home screen.
HttpConfig
[http]: what every request datui makes says about it.
Interval
A duration written with its unit in config: follow_interval = "250ms".
LogConfig
[log]: the log file and how much it says.
NumberFormatTable
Long-form number formatting options. Every field is optional; unset fields take their value from 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 the home screen’s filter.
Theme
Theme containing parsed colors ready for use
ThemeConfig
ViewsConfig
[views]: saved views.

Enums§

CatalogRef
One entry of catalogs: a catalog file’s path, or a table naming it with an id and a label of its own, for a file that cannot be renamed or edited.
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.
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 shorthand, or a full 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 set of built-in colour defaults to start from.

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. Enough that a distribution’s shape and a correlation are stable to two decimals; few enough to 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 are always expensive.
MAX_CHART_ROW_LIMIT
Maximum chart row limit (Polars slice takes u32).
S3_ENDPOINT_VARS
The variables that name an S3 endpoint, in the order they are consulted. The AWS SDKs read the service-specific one first, then the general one; AWS_ENDPOINT is 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} reference in a config path.
expand_home
path with a leading ~ expanded, and nothing else. For a path from the command line: cmd, and PowerShell before 7.4, pass ~\data\a.csv on as typed, as every shell does a quoted "~/a.csv". A $ there has been through the shell already and is part of a name. A path that is there as typed, such as a file named ~ in the working directory, is that path.
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, so nothing that needs escaping is allowed in.
rgb_to_256_color
Convert RGB to nearest 256-color palette index Uses standard xterm 256-color palette
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 file’s mistake: how to get going again. An import that is not there is skipped, and datui config init writes a root file only where there is none.