Skip to main content

FormState

Struct FormState 

Source
pub struct FormState {
    pub fields: Vec<FormField>,
    pub submitted: bool,
}
Expand description

State for a form with multiple fields.

Fields§

§fields: Vec<FormField>

Ordered list of form fields.

§submitted: bool

Whether the form has been successfully submitted.

Implementations§

Source§

impl FormState

Source

pub fn new() -> Self

Create an empty form state.

Source

pub fn field(self, field: FormField) -> Self

Add a field and return the updated form for chaining.

Source

pub fn is_valid(&self) -> bool

Whether the form is currently valid — no field holds an error.

Reflects the last run of each field’s validators (auto-triggered by Context::form_field or run explicitly via validate_all). It does not re-run validation.

§Example
let mut form = FormState::new().field(FormField::new("Name").validate(validators::required("required")));
assert!(form.is_valid()); // no validation run yet
form.validate_all();
assert!(!form.is_valid()); // empty Name failed
Source

pub fn errors(&self) -> Vec<(usize, &str)>

Collect every current field error as (field_index, message) pairs.

§Example
let mut form = FormState::new().field(FormField::new("Name").validate(validators::required("required")));
form.validate_all();
assert_eq!(form.errors(), vec![(0, "required")]);
Source

pub fn validate_all(&mut self) -> bool

Run every field’s own validators, returning true when all pass.

This is the replacement for the deprecated positional validate — validators are co-located with their fields, so there is no index slice to misalign.

§Example
let mut form = FormState::new()
    .field(FormField::new("Email").validate(validators::email()));
let ok = form.validate_all();
Source

pub fn validate_with( &mut self, f: impl Fn(&FormState) -> Vec<(usize, String)>, ) -> bool

Apply cross-field validation rules.

The closure receives the whole form and returns (field_index, message) pairs; each pair sets that field’s error. Returns true when the closure reports no errors. Useful for rules like “confirm password must match password”.

§Example
let mut form = FormState::new()
    .field(FormField::new("Password"))
    .field(FormField::new("Confirm"));
let ok = form.validate_with(|f| {
    if f.value(0) != f.value(1) {
        vec![(1, "passwords must match".to_string())]
    } else {
        vec![]
    }
});
Source

pub fn validate(&mut self, validators: &[FormValidator]) -> bool

👎Deprecated since 0.21.0:

Attach validators per-field via FormField::validate and call validate_all(); positional slices misalign silently.

Validate all fields with a positional slice of function-pointer validators.

Returns true when all validations pass. A field whose index has no matching validator is silently skipped.

Source

pub fn value(&self, index: usize) -> &str

Get field value by index.

Trait Implementations§

Source§

impl Debug for FormState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FormState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.