Struct ExportModal 

pub struct ExportModal {

    pub active: bool,
    pub focus: ExportFocus,
    pub selected_format: ExportFormat,
    pub path_input: TextInput,
    pub csv_delimiter_input: TextInput,
    pub csv_include_header: bool,
    pub source_file: bool,
    pub offer_source_file: bool,
    pub nested_columns: bool,
    pub avro_renames: bool,
    pub csv_compression: Option<CompressionFormat>,
    pub json_compression: Option<CompressionFormat>,
    pub ndjson_compression: Option<CompressionFormat>,
    pub history_limit: usize,
    pub path_error: Option<String>,
}

Fields

active: bool

focus: ExportFocus

selected_format: ExportFormat

path_input: TextInput

csv_delimiter_input: TextInput

csv_include_header: bool

source_file: bool

Add a column naming the file each row came from. See ExportFocus::SourceFile.

offer_source_file: bool

Whether this dataset has files to name. Set when the modal opens.

nested_columns: bool

Whether the view has list, array or struct columns, which a format without nesting writes as JSON; the dialog says so. Set when it opens.

avro_renames: bool

Whether a column or struct field of the view has a name Avro does not allow; the dialog says those are renamed. Set when it opens.

csv_compression: Option<CompressionFormat>

json_compression: Option<CompressionFormat>

ndjson_compression: Option<CompressionFormat>

history_limit: usize

path_error: Option<String>

Why the form cannot export, or why its last write failed, said inline on its own status line. Cleared by typing in the path.

Implementations

impl ExportModal

pub fn new() -> Self

pub fn open( &mut self, default_format: Option<ExportFormat>, history_limit: usize, theme: &Theme, file_delimiter: Option<u8>, )

pub fn close(&mut self)

pub fn suspend(&mut self)

Hide behind a child confirmation without discarding the form; resume brings it back exactly as typed. close is the discard.

pub fn resume(&mut self)

pub fn sync_format_to_path(&mut self)

Follow the typed path’s extension with the format picker, so out.csv never silently receives Parquet bytes. An extension that names no format leaves the picker alone, and an explicit format picked after typing stands, because this runs only when the path itself changes.

pub fn suggest_path(&mut self, stem: &str)

The other direction of Self::sync_format_to_path: a format picked after typing rewrites the path’s format extension, so out.csv never silently receives Parquet bytes from the picker side either. A path whose extension names no format is left alone. A compression suffix survives when the new format supports one and is dropped when it cannot. Offer stem with the format’s extension as the path: Enter takes it as it stands, typing replaces it, and stepping the format carries it along.

pub fn sync_path_to_format(&mut self)

pub fn compression(&self) -> Option<CompressionFormat>

The compression the chosen format writes with; None for one that takes none.

pub fn step_compression(&mut self, delta: i8)

Step the chosen format’s compression through COMPRESSION_OPTIONS.

pub fn step_format(&mut self, delta: i8)

Step the format, carrying the typed path’s extension with it.

pub fn focus_order(&self) -> Vec<ExportFocus>

The fields this modal offers, in the order Tab walks them.

Built as a list rather than a match per field: the options differ by format and one of them depends on the dataset, and a hand-written state machine over both has an arm for every pair.

Trait Implementations

impl Default for ExportModal

fn default() -> Self

Returns the “default value” for a type.

impl Form for ExportModal

type Field = ExportFocus

The modal’s name for a field.

fn fields(&self) -> Vec<(ExportFocus, FieldKind)>

The fields on screen, top to bottom, each with its kind. A field the current state hides or disables is left out, so focus never lands on it.

fn focused(&self) -> ExportFocus

fn set_focused(&mut self, field: ExportFocus)

Put focus on field. Called only with a field of Form::fields; a modal that shows a text cursor in the focused field syncs it here.

fn text_edge(&self, _field: Self::Field) -> (bool, bool)

For a multiline field: whether its cursor is on the first line, and on the last, where ↑ and ↓ leave it.

fn list_row(&self, _field: Self::Field) -> bool

Whether field is a row of a list (a sort, a filter, a column) rather than a setting. A click on a list row only focuses it, so it can be picked to move or remove without changing it; a click on it once focused acts. A setting (a checkbox, a choice, a button) acts on the first click.

fn focused_kind(&self) -> Option<FieldKind>

The focused field’s kind; None when focus is on a field not shown.

fn focus(&mut self, field: Self::Field) -> bool

Focus field if the form shows it: a click on a row, or a modal moving focus itself. Returns whether it did.

fn move_focus(&mut self, delta: isize)

Move focus delta fields along, wrapping. A focus the form no longer shows counts from the top.

fn focus_next(&mut self)

fn focus_prev(&mut self)

fn settle_focus(&mut self)

After a change that hides fields: when the focused one went, focus the first field instead, so it never points at nothing.