Struct BooleanField 

pub struct BooleanField {
    pub name: String,
    pub label: Option<String>,
    pub required: bool,
    pub help_text: Option<String>,
    pub initial: Option<Value>,
}

Boolean field for checkbox input

Fields

name: String

The field name used as the form data key.

label: Option<String>

Optional human-readable label for display.

required: bool

Whether the checkbox must be checked (true) to pass validation.

help_text: Option<String>

Optional help text displayed alongside the field.

initial: Option<Value>

Optional initial (default) value for the field.

Implementations

impl BooleanField

pub fn new(name: String) -> Self

Create a new BooleanField with the given name

Examples

use reinhardt_forms::fields::BooleanField;

let field = BooleanField::new("accept_terms".to_string());
assert_eq!(field.name, "accept_terms");
assert!(!field.required);

pub fn required(self) -> Self

Set the field as required

Examples

use reinhardt_forms::fields::BooleanField;

let field = BooleanField::new("terms".to_string()).required();
assert!(field.required);

pub fn with_label(self, label: impl Into<String>) -> Self

Set the label for the field

Examples

use reinhardt_forms::fields::BooleanField;

let field = BooleanField::new("agree".to_string()).with_label("I agree");
assert_eq!(field.label, Some("I agree".to_string()));

pub fn with_help_text(self, help_text: impl Into<String>) -> Self

Set the help text for the field

Examples

use reinhardt_forms::fields::BooleanField;

let field = BooleanField::new("newsletter".to_string()).with_help_text("Subscribe to newsletter");
assert_eq!(field.help_text, Some("Subscribe to newsletter".to_string()));

pub fn with_initial(self, initial: bool) -> Self

Set the initial value for the field

Examples

use reinhardt_forms::fields::BooleanField;

let field = BooleanField::new("enabled".to_string()).with_initial(true);
assert_eq!(field.initial, Some(serde_json::json!(true)));

Trait Implementations

impl Clone for BooleanField

fn clone(&self) -> BooleanField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BooleanField

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

Formats the value using the given formatter.

impl FormField for BooleanField

fn name(&self) -> &str

Returns the field’s name used as the form data key.

fn label(&self) -> Option<&str>

Returns the human-readable label, if set.

fn required(&self) -> bool

Returns whether this field must have a non-empty value.

fn help_text(&self) -> Option<&str>

Returns optional help text displayed alongside the field.

fn widget(&self) -> &Widget

Returns the widget type used for HTML rendering.

fn initial(&self) -> Option<&Value>

Returns the initial (default) value for this field, if any.

fn clean(&self, value: Option<&Value>) -> FieldResult<Value>

Validates and cleans the submitted value, returning the cleaned result.

fn has_changed(&self, initial: Option<&Value>, data: Option<&Value>) -> bool

Check if the field value has changed from its initial value

fn error_messages(&self) -> HashMap<ErrorType, String>

Get custom error messages for this field