Struct FormField 

#[non_exhaustive]
pub struct FormField {

    pub name: String,
    pub label: Text,
    pub field_type: String,
    pub options: Value,
    pub rules: Vec<Rule>,
    pub translatable: bool,
    pub help: Option<Text>,
    pub enter: FieldEnter,
    pub span: Span,
    pub break_row: bool,
    pub preset: Option<Preset>,
    pub hidden: bool,
    pub trigger: Option<Trigger>,
}

One editable field: the column, its label, its field-type key (resolved through the field-type registry), typed options for that type, the validation rules it carries, and whether it holds translatable content. A serde descriptor, so it is authorable as data (later YAML) as well as by builder.

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.

name: String

label: Text

The field’s label, localized at render. Serde stays a plain string.

field_type: String

The field-type registry key (text, textarea, or a plugin’s vendor.name), resolved to behaviour at render time (see crate::field).

options: Value

The keys that belong to the field’s type, as an object: in a file they are written on the field itself, beside its own. Null when there are none.

rules: Vec<Rule>

Validation rules run on submit (see laterite_core::validation).

translatable: bool

Marks a field whose value is translatable content. A reserved seam: the framework stores the value verbatim; a content-translation plugin reads the flag to manage per-locale values.

help: Option<Text>

Help text shown beneath the control, localized at render.

enter: FieldEnter

What Enter does in this field: submit (the form’s rule), off, or next (moves to the next field).

span: Span

The share of the row the field takes, on a twelve-column grid.

break_row: bool

Starts a new row, whatever room the current one has left.

preset: Option<Preset>

Follows another field as it is typed, until this one is edited.

hidden: bool

Submitted but never shown: a plain hidden input carrying its value. The foreign key of a related record’s form is one.

trigger: Option<Trigger>

Changes when another field’s state meets a condition.

Implementations

impl FormField

pub fn of(name: &str, label: impl Into<Text>, field_type: &str) -> Self

A field of a registered type by key.

pub fn preset(self, field: &str, shape: PresetShape) -> Self

Follows field as it is typed, shaped as shape, until this field is edited.

pub fn trigger(self, trigger: Trigger) -> Self

Changes when trigger’s condition holds on the field it watches.

pub fn text(name: &str, label: impl Into<Text>) -> Self

pub fn textarea(name: &str, label: impl Into<Text>) -> Self

pub fn reference(name: &str, label: impl Into<Text>, source: &str) -> Self

A reference field: a picker over a registered picker source (a vendor.name key), which the field searches and resolves against. Builds the source option so a descriptor needs no raw JSON.

pub fn select( name: &str, label: impl Into<Text>, options: Vec<(&str, &str)>, ) -> Self

A dropdown over a fixed set of (value, label) choices.

pub fn radio( name: &str, label: impl Into<Text>, options: Vec<(&str, &str)>, ) -> Self

The same choices rendered as radio buttons.

pub fn switch(name: &str, label: impl Into<Text>) -> Self

A checkbox over a boolean column.

pub fn date(name: &str, label: impl Into<Text>) -> Self

A calendar date, stored as YYYY-MM-DD.

pub fn password(name: &str, label: impl Into<Text>) -> Self

A password: hashed on save, never rendered back, and left alone when the field is submitted blank on an edit.

pub fn repeater( name: &str, label: impl Into<Text>, fields: Vec<FormField>, ) -> Self

A list of rows, each holding fields, stored as an array of objects.

pub fn repeater_list( name: &str, label: impl Into<Text>, fields: Vec<FormField>, summary_field: Option<&str>, ) -> Self

A repeater whose rows collapse to the line that names them, opening one at a time. summary_field names the sub-field that titles a row; unset, the first one does.

Use it when a row holds more than one or two fields: rendered inline those become columns, and a row of four is already unreadable. A single narrow column is better left inline, where collapsing would hide the one thing worth seeing.

pub fn options(self, options: Value) -> Self

Sets the field type’s typed options (the type validates them at render).

pub fn required(self) -> Self

Requires a non-empty value in every mode.

pub fn required_on(self, mode: Mode) -> Self

Requires a non-empty value in one mode only (for example a password set on create but left unchanged on edit).

pub fn unique(self) -> Self

Requires the value to be unique in this field’s column (a DB probe that ignores the edited row on update).

pub fn max_length(self, n: usize) -> Self

Caps the value’s length.

pub fn min_length(self, n: usize) -> Self

Requires at least n characters when the value is non-empty.

pub fn email(self) -> Self

Requires a syntactically valid email address.

pub fn translatable(self) -> Self

Marks this field as translatable content (see FormField::translatable).

pub fn help(self, text: impl Into<Text>) -> Self

Help text shown beneath the control.

pub fn span(self, span: Span) -> Self

The share of the row this field takes.

pub fn break_row(self) -> Self

Starts a new row.

Trait Implementations

impl Clone for FormField

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 FormField

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

Formats the value using the given formatter.

impl Default for FormField

fn default() -> Self

A text field, named by the key it is written under.

impl<'de> Deserialize<'de> for FormField

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for FormField

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.