Struct tty_form::Form

pub struct Form { /* private fields */ }

A TTY-based form with multiple steps and inputs.

Examples

use tty_form::Form;

let mut form = Form::new();

let mut name_step = form.add_compound_step();
let mut prompt_text = name_step.add_static_text();
prompt_text.set_text("Enter name:");
name_step.add_text_input();

let mut description_step = form.add_description_step();
description_step.set_text("Enter information about this person:");

form.add_text_block_step();

let submission = form.execute();

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(self, interface: &mut Interface<'_>) -> Result<String>

Execute the provided form and return its WYSIWYG result.

Trait Implementations

impl Default for Form

fn default() -> Self

Returns the “default value” for a type.