Struct FormConfig 

#[non_exhaustive]
pub struct FormConfig {
    pub entity: String,
    pub title: Text,
    pub base_path: String,
    pub id_field: String,
    pub fields: Vec<FormField>,
    pub enter: EnterPolicy,
    pub confirm_leave: bool,
    pub focus: FormFocus,
    pub persist: Option<String>,
    pub timestamps: bool,
    /* private fields */
}

A form descriptor: which table, its editable fields, the id column, and the base path the form lives under ({base_path}/new, {base_path}/{id}/edit).

Built with FormConfig::new plus its builder methods. Non-exhaustive so the framework can learn something new about a form after 1.0 without a major bump.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entity: String

title: Text

The screen title, localized at render. Serde stays a plain string.

base_path: String

id_field: String

fields: Vec<FormField>

enter: EnterPolicy

What Enter does in the form’s single-line fields. Default submit.

confirm_leave: bool

Ask before leaving the form with changes unsaved. Default true.

focus: FormFocus

Where the cursor goes when the form opens. Default auto.

persist: Option<String>

The registered persister that writes this form (a dotted vendor.name), or None for the built-in descriptor insert/update. See crate::persist.

timestamps: bool

Stamp created_at and updated_at on write. Opt in per form, because the columns have to exist on this entity’s table.

Implementations

impl FormConfig

pub fn new( entity: impl Into<String>, title: impl Into<Text>, base_path: impl Into<String>, id_field: impl Into<String>, fields: Vec<FormField>, ) -> Self

A form over entity, mounted under base_path, keyed by id_field.

The four arguments are the ones with no sensible default; everything else is opt-in through a builder method, so a later field costs nothing.

pub fn persist(self, name: impl Into<String>) -> Self

Writes this form through a registered persister instead of the built-in descriptor insert/update.

pub fn confirm_leave(self, ask: bool) -> Self

Whether leaving the form with changes unsaved asks first. Default true.

pub fn focus(self, focus: FormFocus) -> Self

Where the cursor goes when the form opens.

pub fn timestamps(self) -> Self

Stamps created_at and updated_at on write. Opt in, because the columns have to exist on this entity’s table.

Trait Implementations

impl Clone for FormConfig

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 FormConfig

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

Formats the value using the given formatter.

impl Default for FormConfig

fn default() -> Self

Everything a descriptor file leaves to the resource level: the entity, the path and the id column are filled in when the file is read.

impl<'de> Deserialize<'de> for FormConfig

where FormConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FormConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.