Struct Form 

pub struct Form {
    pub title: Option<String>,
    pub fields: Vec<Field>,
    pub mode: FormMode,
    /* private fields */
}

A vim-modal form. Holds an ordered list of fields, the focused index, the current FormMode, an optional title, and a submit closure consumed on first call.

Fields

title: Option<String>

fields: Vec<Field>

mode: FormMode

Implementations

impl Form

pub fn new() -> Self

Build an empty form.

pub fn with_title(self, title: impl Into<String>) -> Self

Set an optional title row rendered above the fields.

pub fn with_field(self, field: Field) -> Self

Append a field to the form. Order matters — first field is focused by default and j/k walks the list in order.

pub fn with_submit(self, submit: SubmitFn) -> Self

Register the submit closure. Consumed via Option::take on the first successful submit.

pub fn focused(&self) -> usize

Index of the currently-focused field.

pub fn focused_field(&self) -> Option<&Field>

Borrow the focused field, if any.

pub fn focused_field_mut(&mut self) -> Option<&mut Field>

Mutably borrow the focused field, if any.

pub fn set_focus(&mut self, index: usize)

Programmatically set the focus index. Out-of-range indices are ignored.

pub fn dirty_gen(&self) -> u64

Sum of the form-level dirty counter and every text field’s buffer dirty_gen. Renderers can cheap-check this to skip redraws.

impl Form

pub fn handle_input(&mut self, input: Input) -> Option<FormEvent>

Route a key event through the form. Returns an event if the keystroke produced one (focus moved, value changed, submit fired, etc.).

impl Form

pub fn try_submit(&mut self) -> Option<SubmitOutcome>

Validate every field and, on success, fire the submit closure (consumed via Option::take). Returns:

• Some(SubmitOutcome::Ok) / Some(SubmitOutcome::Err(_)) — submit ran (or no submit was registered, in which case Ok).
• None — validation failed; per-field errors populated.

impl Form

pub fn validate_focused(&mut self) -> bool

Validate the focused field. Returns the same boolean as validate_field.

pub fn validate_all(&mut self) -> Result<(), Vec<(usize, String)>>

Validate every field. On error, returns the list of (field_index, error_message) tuples and leaves each field’s meta.error populated.

Trait Implementations

impl Default for Form

fn default() -> Self

Returns the “default value” for a type.