Struct InteractiveForm 

pub struct InteractiveForm {
    pub target: FormTarget,
    pub protocol: String,
    pub fields: Vec<FormField>,
    pub index: usize,
}

An in-progress interactive create/update form.

Fields

target: FormTarget

What the form will do on submit.

protocol: String

The protocol name (immutable — not itself an editable field).

fields: Vec<FormField>

The ordered fields.

index: usize

Index of the field currently being edited.

Implementations

impl InteractiveForm

pub fn create_server(protocol: &str, schema: &[ParameterDefinition]) -> Self

Build a create form for a server protocol from its declared startup params.

pub fn create_client(protocol: &str, schema: &[ParameterDefinition]) -> Self

Build a create form for a client protocol.

pub fn update_server( id: u32, protocol: &str, schema: &[ParameterDefinition], current: &ServerPrefill, ) -> Self

Build an update form for a running server, prefilled from its current config plus the current values of any declared startup params.

pub fn update_client( id: u32, protocol: &str, schema: &[ParameterDefinition], current: &ClientPrefill, ) -> Self

Build an update form for a running client.

pub fn current_field(&self) -> Option<&FormField>

The field currently being edited, if the form is not yet complete.

pub fn prompt(&self) -> String

A one-line prompt describing the current field.

pub fn title(&self) -> String

A short title for the whole form, e.g. Create http server.

pub fn current_prefill(&self) -> String

The prefill text for the current field (what the input should show).

pub fn submit_current(&mut self, raw: &str)

Record raw as the current field’s value (trimmed) and advance.

pub fn set_field_value(&mut self, name: &str, value: &str) -> bool

Directly set a field’s value by name (used by tests and any non-sequential caller). Returns false if no such field.

pub fn is_complete(&self) -> bool

True once every field has been submitted.

pub fn into_server_form(&self) -> Result<ServerForm>

Assemble the collected field values into a ServerForm. Errors (naming the field) on an unparseable value; the executors do the schema validation.

pub fn into_client_form(&self) -> Result<ClientForm>

Assemble the collected field values into a ClientForm.

Trait Implementations

impl Clone for InteractiveForm

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InteractiveForm

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

Formats the value using the given formatter.