Struct TextField 

pub struct TextField<const N: usize> { /* private fields */ }

Available on crate feature wifi and target_os=none only.

A generic text input field for collecting user input during WiFi provisioning.

Presents a customizable text input box in the captive portal that validates and stores user-provided text to flash. Can be used for device names, locations, or any other text-based configuration.

Multiple TextField instances can be created with different labels and field names to collect various pieces of information during the provisioning process.

See the wifi_auto::fields module example for usage.

Implementations

impl<const N: usize> TextField<N>

pub const fn new_static() -> TextFieldStatic<N>

Create static resources for TextField.

See the wifi_auto::fields module example for usage.

pub fn new( text_field_static: &'static TextFieldStatic<N>, flash: FlashBlock, field_name: &'static str, label: &'static str, default_value: &'static str, ) -> &'static Self

Initialize a new text input field.

Parameters

• text_field_static: Static resources for initialization
• flash: Flash block for persistent storage
• field_name: HTML form field name (e.g., “device_name”, “location”)
• label: HTML label text (e.g., “Device Name:”, “Location:”)
• default_value: Initial value if nothing saved

The maximum length is determined by the generic parameter N.

See the wifi_auto::fields module example for usage.

pub fn text(&self) -> Result<Option<String<N>>>

Load the stored text from flash.

Returns None if no text has been configured yet.

See the wifi_auto::fields module example for usage.

pub fn set_text(&self, text: &String<N>) -> Result<()>

Save new text to flash.

This method allows programmatic updates to the field value, such as when the user modifies configuration via button presses or other UI interactions.

The text must not exceed the maximum length N specified in the type parameter.

Alternatively, you can access the underlying flash block directly for more control over flash operations.

Trait Implementations

impl<const N: usize> WifiAutoField for TextField<N>

fn render(&self, page: &mut String<16384>) -> Result<()>

Render HTML form elements for this field.

fn parse(&self, form: &FormData<'_>) -> Result<()>

Parse and save form data submitted by the user.

fn is_satisfied(&self) -> Result<bool>

Check if this field has valid configuration.

impl<const N: usize> Sync for TextField<N>