Struct FormSet 

pub struct FormSet { /* private fields */ }

FormSet manages multiple forms

Implementations

impl FormSet

pub fn new(prefix: String) -> Self

Create a new FormSet with the given prefix

Examples

use reinhardt_forms::FormSet;

let formset = FormSet::new("form".to_string());
assert_eq!(formset.prefix(), "form");
assert!(!formset.can_delete());

pub fn prefix(&self) -> &str

Returns the prefix used for form field naming.

pub fn can_delete(&self) -> bool

Returns whether forms in this set can be deleted.

pub fn with_extra(self, extra: usize) -> Self

Sets the number of extra empty forms to include.

pub fn with_can_delete(self, can_delete: bool) -> Self

Enables or disables form deletion within this set.

pub fn with_can_order(self, can_order: bool) -> Self

Enables or disables ordering of forms within this set.

pub fn with_max_num(self, max_num: Option<usize>) -> Self

Sets the maximum number of forms allowed.

pub fn with_min_num(self, min_num: usize) -> Self

Sets the minimum number of forms required for validation.

pub fn add_form(&mut self, form: Form) -> Result<(), String>

Add a form to the formset.

Returns an error if adding the form would exceed max_num.

Examples

use reinhardt_forms::{FormSet, Form};

let mut formset = FormSet::new("form".to_string());
let form = Form::new();
assert!(formset.add_form(form).is_ok());
assert_eq!(formset.forms().len(), 1);

use reinhardt_forms::{FormSet, Form};

let mut formset = FormSet::new("form".to_string()).with_max_num(Some(1));
assert!(formset.add_form(Form::new()).is_ok());
assert!(formset.add_form(Form::new()).is_err());

pub fn forms(&self) -> &[Form]

Returns a slice of all forms in this set.

pub fn forms_mut(&mut self) -> &mut Vec<Form>

Returns a mutable reference to the forms vector.

pub fn form_count(&self) -> usize

Returns the number of forms currently in this set.

pub fn total_form_count(&self) -> usize

Returns the total form count including extra empty forms.

pub fn is_valid(&mut self) -> bool

Validate all forms in the formset

Examples

use reinhardt_forms::{FormSet, Form};

let mut formset = FormSet::new("form".to_string());
formset.add_form(Form::new()).unwrap();

pub fn errors(&self) -> &[String]

Returns the formset-level validation errors.

pub fn cleaned_data(&self) -> Vec<&HashMap<String, Value>>

Returns cleaned data from all forms in the set.

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

Get management form data (for tracking forms in HTML)

Examples

use reinhardt_forms::FormSet;

let formset = FormSet::new("form".to_string());
let data = formset.management_form_data();
assert!(data.contains_key("form-TOTAL_FORMS"));

pub fn process_data(&mut self, data: &HashMap<String, HashMap<String, Value>>)

Process bound data from HTML forms.

Respects max_num and silently stops adding forms once the limit is reached.

Examples

use reinhardt_forms::FormSet;
use std::collections::HashMap;
use serde_json::json;

let mut formset = FormSet::new("form".to_string());
let mut data = HashMap::new();
let mut form_data = HashMap::new();
form_data.insert("field".to_string(), json!("value"));
data.insert("form-0".to_string(), form_data);

formset.process_data(&data);
assert_eq!(formset.form_count(), 1);

Trait Implementations

impl Default for FormSet

fn default() -> Self

Returns the “default value” for a type.