Skip to main content

FormState

Struct FormState 

Source
pub struct FormState { /* private fields */ }
Expand description

A controlled-form helper. Create one per form (typically stored in a component’s local state / captured by its closures) and bind fields to Input/Textarea/Select/Radio/Checkbox nodes via FormState::field/FormState::checkbox for the current value and FormState::set/FormState::set_checkbox (typically from .on_input/.on_toggle) to write new values back.

Implementations§

Source§

impl FormState

Source

pub fn new() -> Self

Source

pub fn field(&self, name: &str, default: impl Into<String>) -> Signal<String>

The value signal for string field name, creating it with default on first access. Read this to bind a node’s current value.

Source

pub fn validate(&self, name: &str, f: impl Fn(&str) -> Option<String> + 'static)

Registers a validator for name, run against every new value passed to FormState::set. f returns Some(message) to reject the value (recorded, but the value is still stored — callers can still see what the user typed) or None when it’s valid.

Source

pub fn set(&self, name: &str, value: impl Into<String>)

Sets name’s value (creating the field with an empty default if this is the first write) and re-runs its validator.

Source

pub fn error(&self, name: &str) -> Option<String>

The current validation error for string field name, if any.

Source

pub fn checkbox(&self, name: &str, default: bool) -> Signal<bool>

The boolean field backing a Checkbox, creating it with default on first access.

Source

pub fn set_checkbox(&self, name: &str, value: bool)

Sets boolean field name (creating it if this is the first write).

Source

pub fn is_valid(&self) -> bool

true if every registered string field currently has no validation error. Fields with no validator (or never validated) are always considered valid.

Source

pub fn values(&self) -> HashMap<String, String>

Snapshot of every string field’s current value (e.g. for submission), keyed by field name. Boolean (Checkbox) fields aren’t included — read those individually via FormState::checkbox.

Trait Implementations§

Source§

impl Clone for FormState

Source§

fn clone(&self) -> FormState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.