Struct tty_form::Form

pub struct Form { /* private fields */ }

A TTY-based form with multiple steps and inputs.

Examples

use tty_form::{
    Form,
    step::{Step, CompoundStep, TextBlockStep},
    control::{Control, TextInput},
};

let mut form = Form::new();

let mut name_step = CompoundStep::new();
TextInput::new("Enter a name:", false).add_to(&mut name_step);
name_step.add_to(&mut form);

TextBlockStep::new("Enter a description of this person:").add_to(&mut form);

let submission = form.execute(&mut interface, &mut stdin)?;

Implementations

impl Form

pub fn new() -> Form

Create a new, default terminal form.

pub fn add_step(&mut self, step: Box<dyn Step>)

Append and return a compound step with multiple component controls.

pub fn execute<D: InputDevice>(
    self,
    interface: &mut Interface<'_>,
    input_device: &mut D
) -> Result<String>

Execute the provided form and return its WYSIWYG result.

Trait Implementations

impl Default for Form

fn default() -> Self

Create a new, default terminal form.