Struct Form 

pub struct Form { /* private fields */ }

An independent editable form instance using a compiled structure.

Implementations

impl Form

pub fn new( template: FormTemplate, data: &Value, options: BindOptions, ) -> FormResult<Self>

Create an instance, prepare default data and evaluate fields.

pub fn template(&self) -> &FormTemplate

Return the shared structure without instance values.

pub fn fields(&self) -> &[Value]

Return the current field models.

pub fn revision(&self) -> u64

Number of successful instance updates.

pub fn get_data(&self) -> Value

Return detached submission data.

pub fn set_data(&mut self, data: &Value) -> FormResult<()>

Replace record data, restart the history and reevaluate the form atomically.

pub fn get_value(&self, path: &str) -> FormResult<Value>

Return a detached value relative to the data root.

pub fn set_value(&mut self, path: &str, value: Value) -> FormResult<()>

Update one data path and reevaluate the form atomically.

pub fn undo(&mut self) -> FormResult<()>

Restore the record before the last data change; the reverted record can be redone (CURT-011).

pub fn redo(&mut self) -> FormResult<()>

Reapply the most recently undone data change (CURT-012).

pub fn can_undo(&self) -> bool

Whether undo can restore an earlier record (CURT-061).

pub fn can_redo(&self) -> bool

Whether redo can reapply a reverted change (CURT-061).

pub fn toggle_row(&mut self, path: &str, key: &str) -> FormResult<()>

Expand a collapsed row or collapse an expanded one; the record and the revision do not change.

pub fn set_all_expanded(&mut self, expanded: bool) -> FormResult<()>

Expand every row, or collapse every collapsible row; the record and the revision do not change.

pub fn add_row( &mut self, path: &str, options: AddRowOptions, ) -> FormResult<String>

Insert a row with supplied data or field defaults.

pub fn copy_row( &mut self, path: &str, key: &str, options: AddRowOptions, ) -> FormResult<String>

Copy current values and generate new identities for nested repeated rows.

pub fn remove_row(&mut self, path: &str, key: &str) -> FormResult<()>

Remove a row while enforcing the minimum count.

pub fn move_row(&mut self, path: &str, key: &str, index: i64) -> FormResult<()>

Move a row without changing its identity or values; index is the position after the move, and a position outside the rows fails.

pub fn rekey_row( &mut self, path: &str, old_key: &str, new_key: &str, ) -> FormResult<()>

Apply a saved sequence key to one row and update its descendant paths.

Trait Implementations

impl Clone for Form

fn clone(&self) -> Form

Returns a duplicate of the value.

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

Performs copy-assignment from source.