Struct Builder 

pub struct Builder {
    pub state: String,
    pub name: String,
    pub kind: Kind,
    pub instructions: String,
    pub yes: String,
    pub no: String,
    pub options: Vec<(String, String)>,
    pub levels: Vec<String>,
    pub focus: usize,
    pub cursor: usize,
    pub message: Option<String>,
    pub existing: Vec<String>,
    /* private fields */
}

Fields

state: String

name: String

kind: Kind

instructions: String

yes: String

no: String

options: Vec<(String, String)>

levels: Vec<String>

focus: usize

cursor: usize

message: Option<String>

existing: Vec<String>

The names the session already holds, so the form can say what it would overwrite.

Implementations

impl Builder

pub fn new(state: String, name: &str) -> Self

Opens on the first field that still needs an answer: the state if there is none, the name if there is no name, otherwise the type.

pub fn of_kind(self, kind: Kind) -> Self

Open on this type rather than a noul.

This is how a second question of the same type costs nothing to reach: after one is added the form reopens on the type just used, instead of falling back to a noul every time.

pub fn over(self, existing: Vec<String>) -> Self

The names the session already holds; committing over one of them asks first.

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

The focusable fields, in tab order, for the current question type.

pub fn focused(&self) -> Field

pub fn text(&self, field: Field) -> &str

pub fn key(&mut self, key: KeyEvent) -> Outcome

pub fn add_row(&mut self)

Ctrl-O, or Enter on the last row: one more option or level.

pub fn delete_row(&mut self)

Ctrl-X: drop the row the cursor is on.

pub fn preview(&self) -> Value

The question as it would go on the wire right now, incomplete parts included.

pub fn as_command(&self) -> String

The equivalent one-line command, so builder mode teaches the fast path.