Struct Meta 

pub struct Meta {
    pub name: String,
    pub description: Option<String>,
    pub examples: Vec<(Value, Option<String>)>,
    pub default: Option<Value>,
    pub convert: Option<ValueType>,
}

Human-facing metadata a validator carries and attaches to its errors.

Set through the WithMeta builder methods (with_name, with_description, with_default, to_int, …) available on every validator. On a validation failure a validator attaches its own Meta to the Error (innermost wins), so messages can name the field and offer a description, examples, and a default. convert requests a post-validation output cast (see Validator::validate).

Fields

name: String

description: Option<String>

examples: Vec<(Value, Option<String>)>

Example values, each with an optional note explaining it.

default: Option<Value>

convert: Option<ValueType>

Target type for the post-validation output cast, if any.

Implementations

impl Meta

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

A metadata block with just the name.

Trait Implementations

impl Clone for Meta

fn clone(&self) -> Meta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Meta

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

Formats the value using the given formatter.

impl Default for Meta

fn default() -> Meta

Returns the “default value” for a type.

impl PartialEq for Meta

fn eq(&self, other: &Meta) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Meta