Struct es_htmlform::Field

pub struct Field<'a> { /* fields omitted */ }

Represents a form field/element.

A Field can convert itself to JSON (and other formats, using serde) and can perform validation of its Values based on its Constraints. Note that the value field always contains a Vec of Values, close to how HTML url encoding works (where every key can appear more than once and every value is a string, or optional).

Methods

impl<'a> Field<'a>

pub fn new(
    name: &'a str,
    label: &'a str,
    element: Element,
    required: bool,
    values: Option<Vec<Value>>,
    choices: &'a [(&'a str, &'a str)],
    constraints: Vec<Constraint<'a>>,
    attributes: Vec<Attr<'a>>
) -> Field<'a>

Initialize a Field.

It is advised to use the builder-style methods on HtmlForm to instantiate, since those perform additional checks and prepare arguments.

pub fn values(&self) -> Vec<Value>

Returns a Vec of 0 or more non-empty values from self.values.

pub fn validate(&self, values: &[&Value]) -> Result<(), ValidationError>

Validate a set of values

Note that this assumes values contains the correct amount of non-empty values for this Field, so dealing with errors regarding self.required and amount of values should be done before this method is called.

Generally, this method is not called directly, but indirectly by HtmlForm's update().

pub fn empty(&mut self)

Clear the Field's values.

pub fn set_values(&mut self, values: Vec<&Value>)

Set the Field's values.

Trait Implementations

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for Field<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.