Struct JSONField 

pub struct JSONField {
    pub name: String,
    pub required: bool,
    pub error_messages: HashMap<String, String>,
    pub widget: Widget,
    pub help_text: String,
    pub initial: Option<Value>,
    pub require_object: bool,
    pub require_array: bool,
    pub required_keys: Vec<String>,
    pub max_depth: usize,
}

A form field for JSON data with optional schema validation.

Fields

name: String

The field name used as the form data key.

required: bool

Whether this field must be filled in.

error_messages: HashMap<String, String>

Custom error messages keyed by error type.

widget: Widget

The widget type used for rendering this field.

help_text: String

Help text displayed alongside the field.

initial: Option<Value>

Optional initial (default) value for the field.

require_object: bool

Whether to validate JSON is an object (not array, string, etc.)

require_array: bool

Whether to validate JSON is an array

required_keys: Vec<String>

Required keys for JSON objects

max_depth: usize

Maximum nesting depth for JSON deserialization to prevent stack overflow

Implementations

impl JSONField

pub fn new(name: impl Into<String>) -> Self

Create a new JSONField

Examples

use reinhardt_forms::fields::JSONField;

let field = JSONField::new("config");
assert_eq!(field.name, "config");
assert!(field.required);

pub fn required(self, required: bool) -> Self

Sets whether this field is required.

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

Sets the help text displayed alongside the field.

pub fn initial(self, value: Value) -> Self

Sets the initial (default) JSON value.

pub fn require_object(self) -> Self

Requires the JSON value to be an object.

pub fn require_array(self) -> Self

Requires the JSON value to be an array.

pub fn required_keys(self, keys: Vec<String>) -> Self

Sets the list of keys that must be present in JSON objects.

pub fn max_depth(self, depth: usize) -> Self

Set the maximum nesting depth for JSON deserialization.

This prevents stack overflow attacks from deeply nested JSON payloads. Default is 64.

pub fn error_message( self, error_type: impl Into<String>, message: impl Into<String>, ) -> Self

Overrides the error message for a specific error type.

Trait Implementations

impl Clone for JSONField

fn clone(&self) -> JSONField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JSONField

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

Formats the value using the given formatter.

impl FormField for JSONField

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 widget(&self) -> &Widget

Returns the widget type used for HTML rendering.

fn required(&self) -> bool

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

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

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

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

Returns optional help text displayed alongside the field.

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