runique 3.0.2

A Django-inspired web framework for Rust with ORM, templates, and comprehensive security middleware
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! Boolean field `BooleanField`: HTML checkbox with unchecked case management.
use crate::forms::base::*;
use crate::utils::aliases::ATera;
use crate::utils::trad::tf;
use async_trait::async_trait;
use serde::Serialize;

/// Checkbox or radio input for boolean values.
/// Use [`BooleanField::new`] for a checkbox, [`::radio`](BooleanField::radio) for a radio button.
#[derive(Clone, Serialize, Debug)]
pub struct BooleanField {
    pub base: FieldConfig,
}

impl CommonFieldConfig for BooleanField {
    fn get_field_config(&self) -> &FieldConfig {
        &self.base
    }

    fn get_field_config_mut(&mut self) -> &mut FieldConfig {
        &mut self.base
    }
}

impl BooleanField {
    /// Creates a checkbox field. Unchecked state is normalized to `"false"` by `fill()`.
    pub fn new(name: &str) -> Self {
        Self {
            base: FieldConfig::new(name, "checkbox", "base_boolean.html"),
        }
    }

    /// Creates a radio button field (`<input type="radio">`).
    pub fn radio(name: &str) -> Self {
        let mut field = Self::new(name);
        field.base.type_field = "radio".to_string();
        field
    }

    /// 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 required(mut self) -> Self {
        self.set_required(true, None);
        self
    }

    /// Overrides the auto-generated label.
    pub fn label(mut self, label: &str) -> Self {
        self.base.label = label.to_string();
        self
    }

    /// Pre-selects the checkbox as checked.
    pub fn checked(mut self) -> Self {
        self.base.value = "true".to_string();
        self
    }

    /// Pre-selects the checkbox as unchecked (default).
    pub fn unchecked(mut self) -> Self {
        self.base.value = "false".to_string();
        self
    }
}

#[async_trait]
impl FormField for BooleanField {
    async fn validate(&mut self) -> bool {
        // A boolean field is always valid: "true" or "false" (unchecked = false).
        // `required` doesn't mean "must be checked"; the column's NULL-ness comes
        // from the model (`nullable`).
        // To force the check (e.g., TOS), use clean() with a custom error.
        self.clear_error();
        true
    }

    fn render(&self, tera: &ATera) -> Result<String, String> {
        let mut context = self.base_context();
        context.insert("input_type", &self.base.type_field);

        // Add the "checked" state
        let is_checked = self.base.value == "true";
        context.insert("checked", &is_checked);

        tera.render(&self.base.template_name, &context)
            .map_err(|e| {
                tf(
                    "forms.finalize_error",
                    &[&self.base.template_name, &e.to_string()],
                )
                .to_string()
            })
    }
}