Enum Input 

#[non_exhaustive]
pub enum Input {
    Number {
        label: Option<String>,
        initial_value: f64,
        min: Option<f64>,
        max: Option<f64>,
    },
    Slider {
        label: Option<String>,
        min: f64,
        max: f64,
        step: f64,
        initial_value: f64,
    },
    Dropdown {
        label: Option<String>,
        options: Vec<Choice>,
        initial_value: usize,
    },
    Text {
        label: Option<String>,
        initial_value: String,
        multiline: bool,
        max_length: usize,
    },
    Checkbox {
        label: Option<String>,
        initial_value: bool,
    },
    MultiSelect {
        label: Option<String>,
        options: Vec<Choice>,
        initial_values: Vec<usize>,
    },
    Image {
        label: Option<String>,
    },
    Table {
        label: Option<String>,
    },
    Described {
        input: Box<Input>,
        unit: Option<String>,
        help: Option<String>,
    },
}

An input component definition. All fields are required in submitted forms.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Number

A numerical textbox with optional inclusive bounds.

Fields

label: Option<String>

Plain-text label, or a generated one-based label.

initial_value: f64

Initial finite value.

min: Option<f64>

Inclusive minimum, when present.

max: Option<f64>

Inclusive maximum, when present.

Slider

A bounded numerical slider.

Fields

label: Option<String>

Plain-text label, or a generated one-based label.

min: f64

Inclusive minimum and step origin.

max: f64

Inclusive maximum.

step: f64

Positive finite increment from the minimum.

initial_value: f64

Initial finite value, on a step within the range.

Dropdown

A dropdown whose options may carry numerical or text values.

Fields

label: Option<String>

Plain-text label, or a generated one-based label.

options: Vec<Choice>

Non-empty list of labeled choices.

initial_value: usize

Zero-based index of the initially selected option.

Text

A single- or multiple-line text input.

Fields

label: Option<String>

Plain-text label.

initial_value: String

Initial text, which may be empty.

multiline: bool

Display multiple lines when true.

max_length: usize

Maximum Unicode scalar values; must be 1–100,000.

Checkbox

A boolean checkbox.

Fields

label: Option<String>

Plain-text label.

initial_value: bool

Initial checked state.

MultiSelect

A list of independently selectable labeled values.

Fields

label: Option<String>

Plain-text label.

options: Vec<Choice>

Nonempty, unique numerical or text choices.

initial_values: Vec<usize>

Initially selected option indices, without duplicates.

Image

Select a local PNG or JPEG, up to 8 MiB and 4096×4096 pixels.

Fields

label: Option<String>

Plain-text label.

Table

Import a UTF-8 CSV with a header and up to 1,000 data rows.

Fields

label: Option<String>

Plain-text label.

Described

Presentation metadata around an input; use with_unit and with_help.

Fields

input: Box<Input>

The underlying component.

unit: Option<String>

Displayed measurement unit.

help: Option<String>

Plain-text explanation shown below the control.

Implementations

impl Input

pub fn number(label: impl Into<String>, initial_value: f64) -> Self

Create an unbounded numerical textbox with a label.

pub fn text( label: impl Into<String>, initial_value: impl Into<String>, multiline: bool, ) -> Self

Create a text input with a 4,096-character limit.

pub fn image(label: impl Into<String>) -> Self

Create a local raster-image input.

pub fn table(label: impl Into<String>) -> Self

Create a CSV table input.

pub fn checkbox(label: impl Into<String>, initial_value: bool) -> Self

Create a checkbox.

pub fn with_unit(self, value: impl Into<String>) -> Self

Show a unit alongside the label, without changing the model value.

pub fn with_help(self, value: impl Into<String>) -> Self

Show explanatory text below the control.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Input

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.