Struct BooleanField 

pub struct BooleanField {
    pub base: FieldConfig,
}

Checkbox or radio input for boolean values. Use BooleanField::new for a checkbox, ::radio for a radio button.

Fields

base: FieldConfig

Implementations

impl BooleanField

pub fn new(name: &str) -> Self

Creates a checkbox field. Unchecked state is normalized to "false" by fill().

pub fn radio(name: &str) -> Self

Creates a radio button field (<input type="radio">).

pub fn required(self) -> Self

Marks the field as required. For a checkbox, this means NOT NULL in DB — not “must be checked”. To force the user to tick (e.g. ToS), use clean() with a custom error instead.

pub fn label(self, label: &str) -> Self

Overrides the auto-generated label.

pub fn checked(self) -> Self

Pre-selects the checkbox as checked.

pub fn unchecked(self) -> Self

Pre-selects the checkbox as unchecked (default).

Trait Implementations

impl Clone for BooleanField

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommonFieldConfig for BooleanField

fn get_field_config(&self) -> &FieldConfig

fn get_field_config_mut(&mut self) -> &mut FieldConfig

fn is_password(&self) -> bool

true if the field’s value must never be exposed.

impl Debug for BooleanField

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

Formats the value using the given formatter.

impl FormField for BooleanField

fn validate<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Field-type specific validation

fn render(&self, tera: &ATera) -> Result<String, String>

HTML rendering of the field

fn name(&self) -> &str

fn label(&self) -> &str

fn value(&self) -> &str

fn placeholder(&self) -> &str

fn field_type(&self) -> &str

fn template_name(&self) -> &str

fn error(&self) -> Option<&String>

fn required(&self) -> bool

fn set_name(&mut self, name: &str)

fn set_label(&mut self, label: &str)

fn set_value(&mut self, value: &str)

fn set_placeholder(&mut self, placeholder: &str)

fn set_error(&mut self, message: String)

fn clear_error(&mut self)

Resets the field error (explicit equivalent of set_error(""))

fn set_required(&mut self, required: bool, msg: Option<&str>)

fn set_html_attribute(&mut self, key: &str, value: &str)

fn set_readonly(&mut self, readonly: bool, msg: Option<&str>)

fn set_disabled(&mut self, disabled: bool, msg: Option<&str>)

fn set_submitted_value(&mut self, value: &str)

Sets a value that came from the request (Forms::fill), as opposed to one set by code. Same as set_value unless the field has to check where the value comes from — a file field only takes a path to a file this request uploaded.

fn set_type_bounds(&mut self, _min: i128, _max: i128) -> bool

Holds an integer field to what its Rust column type can store. false if this isn’t an integer field.

fn bounds(&self) -> FieldBounds

The lengths or values this field accepts; none by default.

fn cap_max_size(&mut self, _bytes: u64)

Lowers the accepted upload size to the column’s, if the field allows more.

fn model_max_size(&self) -> Option<u64>

Model-defined ceiling for max_size (file fields only). None for other field types.

fn set_max_size_bounded(&mut self, _size: FileSize) -> Result<(), String>

Overrides the effective max_size. Returns Err if it exceeds the model ceiling.

fn base_context(&self) -> Context

Rendering context shared by every field.

fn finalize<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Finalization (e.g., password hashing)

fn to_json_value(&self) -> Value

fn to_json_required(&self) -> Value

fn to_json_readonly(&self) -> Value

fn to_json_disabled(&self) -> Value

fn to_json_attributes(&self) -> Value

fn to_json_meta(&self) -> Value

impl From<BooleanField> for GenericField

fn from(f: BooleanField) -> Self

Converts to this type from the input type.

impl Serialize for BooleanField

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.