Struct AnalysisModal 

pub struct AnalysisModal {

    pub scroll_position: usize,
    pub selected_column: Option<usize>,
    pub describe_columns: ColumnScroll,
    pub distribution_columns: ColumnScroll,
    pub correlation_columns: ColumnScroll,
    pub sample: Sample,
    pub sample_dataset: Option<u64>,
    pub sample_run_for: Option<u64>,
    pub sample_form: Option<SampleForm>,
    pub own_sample: Option<Sample>,
    pub table_state: TableState,
    pub distribution_table_state: TableState,
    pub correlation_table_state: TableState,
    pub sidebar_state: TableState,
    pub describe_results: Option<AnalysisResults>,
    pub distribution_results: Option<AnalysisResults>,
    pub correlation_results: Option<AnalysisResults>,
    pub computing: Option<AnalysisProgress>,
    pub view: AnalysisView,
    pub focus: AnalysisFocus,
    pub selected_tool: Option<AnalysisTool>,
    pub selected_distribution: Option<usize>,
    pub selected_correlation: Option<(usize, usize)>,
    pub correlation_method: CorrelationMethod,
    pub selected_theoretical_distribution: DistributionType,
    pub distribution_selector_state: TableState,
    pub histogram_scale: HistogramScale,
    pub quality: QualityState,
    pub results_view: Option<u64>,
    /* private fields */
}

Fields

scroll_position: usize

selected_column: Option<usize>

describe_columns: ColumnScroll

distribution_columns: ColumnScroll

correlation_columns: ColumnScroll

Kept on the selected cell by the matrix as it draws.

sample: Sample

The rows every tool reads (one scope, method, size and seed), so tools compare like with like. Kept across opens; s edits it.

sample_dataset: Option<u64>

The dataset the sample’s scope was chosen for: a partition or file scope means nothing on another.

sample_run_for: Option<u64>

The dataset a sample last ran on; after that, a tool with no result runs at once instead of asking with the Sample form.

sample_form: Option<SampleForm>

The Sample form, while it is open.

own_sample: Option<Sample>

The tools’ own sample, set aside while the view has its own sample, which every tool then reads whole.

table_state: TableState

distribution_table_state: TableState

correlation_table_state: TableState

sidebar_state: TableState

describe_results: Option<AnalysisResults>

Cached results per tool; each tool computes and stores its own state independently.

distribution_results: Option<AnalysisResults>

correlation_results: Option<AnalysisResults>

computing: Option<AnalysisProgress>

Set while a tool runs: its phase and progress, drawn in place of results.

view: AnalysisView

focus: AnalysisFocus

selected_tool: Option<AnalysisTool>

None = no tool selected yet (show instructions); Some(tool) = user chose a tool (may be computing or showing results).

selected_distribution: Option<usize>

selected_correlation: Option<(usize, usize)>

correlation_method: CorrelationMethod

The coefficient the matrix and the pair detail show; both are computed.

selected_theoretical_distribution: DistributionType

distribution_selector_state: TableState

histogram_scale: HistogramScale

quality: QualityState

Data Quality: its plan, its report and where the cursor is in each.

results_view: Option<u64>

The view (DataTableState::len_generation) the results are of.

Implementations

impl AnalysisModal

pub fn with_sample_rows(rows: usize) -> Self

A modal whose shared sample starts at the configured size: [performance] analysis_sample_rows, where 0 means every row.

pub fn open(&mut self, view: Option<u64>)

Open the screen on view: a close’s results on this view come back as they were; on any other view every tool starts empty.

pub fn close(&mut self)

Close the screen, keeping the results for the next open on the same view.

pub fn current_results(&self) -> Option<&AnalysisResults>

Returns the cached results for the currently selected tool, if any.

pub fn switch_focus(&mut self)

Tab on the main view: the tool list and the result trade focus. Not offered on detail views (one focusable thing) or before a tool is chosen.

pub fn highlighted_tool(&self) -> Option<AnalysisTool>

The tool under the sidebar cursor.

pub fn select_tool(&mut self)

Select the tool under the sidebar cursor; the caller places the cursor.

pub fn next_tool(&mut self)

pub fn previous_tool(&mut self)

pub fn open_distribution_detail(&mut self)

pub fn open_correlation_detail(&mut self)

pub fn close_detail(&mut self)

pub fn scroll_left(&mut self)

pub fn scroll_right(&mut self)

pub fn column_scroll(&self) -> Option<&ColumnScroll>

The selected tool’s statistic scroll, for the tools that scroll by statistic.

pub fn follow_view_sample(&mut self, sampled: bool)

Read the view’s sample whole while it has one (sampled), and the tools’ own sample again once it has none.

pub fn quality_row_count(&self) -> usize

pub fn quality_selected_is_clean(&self) -> bool

Whether the highlighted Overview entry is the clean-columns entry, which opens no rows and instead lists the checks.

pub fn selected_finding(&self) -> Option<(&QualityReport, Finding)>

The report on screen and the finding under the cursor, as Overview lists them: narrowed and ordered.

pub fn open_findings_picker(&mut self, by_column: bool)

Narrow the findings to a column (by_column) or a check, from a list of those the report has, the current one selected.

pub fn cycle_findings_order(&mut self)

The next order for the findings, keeping the finding under the cursor under it.

pub fn clear_findings_narrowing(&mut self)

Show every finding again, in the order chosen.

pub fn sample_key_opens_form(&self) -> bool

Whether s opens the Sample form: on a tool’s main view with nothing else holding keys (run, popup, editor, text field).

pub fn export_typing(&self) -> bool

Whether the export dialog’s path owns typed characters.

pub fn intent_typing(&self) -> bool

Whether a Column intent field owns typed characters, so Ctrl-C and ? type.

pub fn sample_scope_typing(&self) -> bool

Whether the Sample form’s scope field owns typed characters, so Ctrl-C and ? type.

pub fn quality_expected_typing(&self) -> bool

Whether the Expected editor’s From or Before has the cursor, so all but its own keys type.

pub fn open_trend_detail(&mut self)

Open the bars of the Trends line under the cursor, the first bar selected.

pub fn cycle_trend_detail_metric(&mut self)

The next measure in a bar’s detail, on the same column’s line. A column with nothing to draw in it has no line, and Trends lists what does.

pub fn close_to_trends(&mut self)

Back to Trends from a bar detail or the gaps, the line still selected.

pub fn set_quality_page(&mut self, page: QualityPage)

pub fn set_quality_column_page(&mut self, page: QualityPage)

Move between the column lens and its detail, keeping the selected column.

pub fn open_segment_detail(&mut self)

Open the highlighted segment’s columns, or go back to the list with the segment still selected.

pub fn close_segment_detail(&mut self)

pub fn segment_order(&self) -> Vec<usize>

The order Segments lists its rows in.

pub fn selected_segment(&self) -> Option<usize>

The segment under the cursor on Segments, whichever order it is listed in.

pub fn toggle_segment_order(&mut self)

List segments in their own order or clearest change first, keeping the one under the cursor under it.

pub fn open_interval_detail(&mut self)

Open the highlighted interval’s detail, its first count under the cursor.

pub fn close_interval_detail(&mut self)

Back to the list, the interval still selected.

pub fn interval_facts(&self) -> Vec<IntervalFact>

The counts an interval’s detail lists, each with rows it can open: those the interval measured, in the order the detail shows them.

pub fn selected_interval_fact(&self) -> Option<IntervalFact>

The count under the cursor in an interval’s detail.

pub fn interval_evidence( &self, schema: Option<&Schema>, ) -> Option<(Expr, String, usize)>

The rows behind the selected count in an interval’s detail, when its values identify them: a predicate over the run’s rows, with a label. schema (where known) lets a partition segment compare in its column’s type.

pub fn scroll_quality_detail(&mut self, rows: i32)

Move the finding popup by rows, within what it last drew.

pub fn show_quality_tab(&mut self, page: QualityPage)

Show a tab, keeping the column in view across Columns, Segments and Trends.

pub fn step_quality_tab(&mut self, forward: bool)

The next or previous tab, stopping at either end.

pub fn cycle_quality_metric(&mut self)

pub fn quality_result_plan(&self) -> &DataQualityPlan

The plan the on-screen result was measured with (the plan until a run exists), so a draft never relabels what was measured.

pub fn quality_plan_pending(&self) -> bool

The plan differs from the one the result on screen was measured with.

pub fn setup_row(&self) -> SetupRow

The Setup row under the cursor.

pub fn setup_edited(&self) -> bool

Whether Setup holds staged changes Esc would discard.

pub fn plan_choices( &self, row: SetupRow, context: &PlanContext, ) -> Vec<(String, PlanChoice)>

The choices a Setup row offers, in the words the header uses.

pub fn open_plan_picker(&mut self, row: SetupRow, context: &PlanContext)

Open the focused Setup row’s choices, the current one selected.

pub fn open_format_picker(&mut self, column: &str, examples: &[String])

How column can be read as time: each format with how many of the on-screen examples it reads, best first, and reading as text again when it has a format.

pub fn choose_plan_picker(&mut self) -> Option<String>

Take the picker’s selection into the plan and close it. Returns a text column chosen to read as time: its format is the next choice.

pub fn cycle_setup_choice( &mut self, row: SetupRow, context: &PlanContext, forward: bool, )

The next or previous choice of a Setup row whose choices are a short list, in place: ←→ on Grain, Compare, Values, Latency and Window by.

pub fn cycle_quality_time_role( &mut self, role_index: usize, columns: &[String], forward: bool, )

pub fn move_row(&mut self, step: ListMove, rows: usize)

Move the focused tool’s cursor by step in rows rows, ten to a page. The correlation matrix moves its row, keeping its column; Home and End take the first and last off-diagonal pair.

pub fn install_correlations(&mut self, results: AnalysisResults)

Install the matrix a run read. The cursor stays if still a cell, else starts on the first off-diagonal pair, where Enter opens a detail.

pub fn correlation_size(&self) -> usize

The number of columns in the correlation matrix on screen.

pub fn distribution_choices(&self) -> usize

The families the distribution detail’s selector lists for the column under the cursor.

pub fn move_correlation_cell(&mut self, (rows, cols): (isize, isize))

Move the correlation cursor by (rows, columns), stopping at edges; the matrix scrolls to keep it in view as it draws.

pub fn next_distribution(&mut self)

pub fn previous_distribution(&mut self)

pub fn select_distribution(&mut self)

Trait Implementations

impl Default for AnalysisModal

fn default() -> Self

Returns the “default value” for a type.