Struct SampleForm 

pub struct SampleForm {

    pub inline: bool,
    pub view: bool,
    pub bytes_per_row: Option<usize>,
    pub source_bytes_per_row: Option<usize>,
    pub anyway: bool,
    pub draft: Sample,
    pub kind: RowsKind,
    pub field: SampleField,
    pub context: SampleContext,
    pub partition_column: usize,
    pub partition_values: TextInput,
    pub files: TextInput,
    pub range_from: TextInput,
    pub range_to: TextInput,
    pub time_column: usize,
    pub time_from: TextInput,
    pub time_before: TextInput,
    pub size: TextInput,
    pub seed: TextInput,
    pub error: Option<String>,
    pub file_offset: usize,
}

Fields

inline: bool

Before a tool’s first run the form sits in its empty pane, and Enter is what runs it; otherwise it floats over a result, and Enter applies a change.

view: bool

The form edits the view’s sample, the step under its query: Every row is “No sample” there, which takes the sample away.

bytes_per_row: Option<usize>

Bytes a row of the view takes, every column, as the table measured them: what the Size row’s estimate of a sample of the view is worked out from.

source_bytes_per_row: Option<usize>

The same of a row of the source, every column it has: a sample of the source (partitions, files, a time range, the source unfiltered) reads them.

anyway: bool

The memory warning has been shown for the form as it stands: Enter again draws anyway. Any edit takes it back.

draft: Sample

kind: RowsKind

field: SampleField

context: SampleContext

partition_column: usize

partition_values: TextInput

files: TextInput

range_from: TextInput

range_to: TextInput

time_column: usize

time_from: TextInput

time_before: TextInput

size: TextInput

The sample size as typed: 100,000, 50k, 2m. Read on Enter.

seed: TextInput

Any number: the same seed draws the same rows, so 0 or 1 is a sample anyone can repeat.

error: Option<String>

file_offset: usize

First source file shown in the numbered list under the Files row.

Implementations

impl SampleForm

pub fn new(sample: &Sample, context: SampleContext, theme: &Theme) -> Self

pub fn set_scope(&mut self, scope: &QualityScope)

Load a scope into the form’s rows: its kind, and that kind’s inputs.

pub fn kinds(&self) -> Vec<RowsKind>

The kinds of rows this table offers, in the order ←/→ steps them.

pub fn fields(&self) -> Vec<SampleField>

The rows on screen, top to bottom.

pub fn input(&self, field: SampleField) -> Option<&TextInput>

pub fn input_mut(&mut self, field: SampleField) -> Option<&mut TextInput>

pub fn sync_focus(&mut self, form_focused: bool)

Show the text cursor in the focused text row only, and only while the form has the cursor at all.

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

←/→ on the focused row. Each ring steps both ways, so Left undoes Right.

pub fn choice(&self, field: SampleField) -> String

The choice a ←/→ row shows, in words.

pub fn partition_values_known(&self) -> Vec<String>

The values of the chosen partition column that the source’s files hold, from their column=value path segments, in order.

pub fn no_sample(&self) -> bool

The form takes the view’s sample away: No sample is chosen.

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

Rows the sample will hold, when that can be told before it is drawn: the size, or the rows there are when fewer. Not for an equal-per-value sample, whose size is per value.

pub fn estimate(&self) -> Option<u64>

The bytes the sample will take, from the bytes per row of what it reads.

pub fn edited(&mut self)

An edit: what was said about the form as it stood no longer stands.

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

The file numbers typed so far, for marking the list under the Files row.

pub fn finish(&self) -> Result<Sample, String>

The draft with the rows the form describes, or why it cannot say which.

Trait Implementations

impl Form for SampleForm

type Field = SampleField

The modal’s name for a field.

fn fields(&self) -> Vec<(SampleField, 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) -> SampleField

fn set_focused(&mut self, field: SampleField)

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.