Struct StaticMap 

pub struct StaticMap { /* private fields */ }

(static_map feature) Accepts a map with a known set of keys.

Each declared key is either required or optional, and may carry a validator for its value. By default keys not declared in the schema are rejected; call StaticMap::allow_unknown to permit them.

Implementations

impl StaticMap

pub fn with_meta(self, meta: Meta) -> Self

Attach human-facing metadata (name, description, examples, default, output conversion).

pub fn new() -> Self

pub fn required( self, key: impl Into<String>, validator: impl Into<Box<dyn Validator>>, ) -> Self

Declare a required key whose value is validated by validator.

pub fn optional( self, key: impl Into<String>, validator: impl Into<Box<dyn Validator>>, ) -> Self

Declare an optional key whose value, when present, is validated by validator.

pub fn required_any(self, key: impl Into<String>) -> Self

Declare a required key whose value is accepted without validation.

pub fn optional_any(self, key: impl Into<String>) -> Self

Declare an optional key whose value is accepted without validation.

pub fn deny_unknown(self) -> Self

Reject keys not declared in the schema (the default).

pub fn allow_unknown(self) -> Self

Accept keys not declared in the schema, leaving their values untouched.

Trait Implementations

impl Default for StaticMap

fn default() -> StaticMap

Returns the “default value” for a type.

impl Validator for StaticMap

fn meta(&self) -> &Meta

This validator’s human-facing metadata.

fn meta_mut(&mut self) -> &mut Meta

Mutable access to this validator’s metadata (backs the WithMeta builder setters).

fn check(&self, value: &mut Value) -> Result<(), Error>

The validation rule: check (and coerce) value in place.

fn validate(&self, value: &mut Value) -> Result<(), Error>

Run check; on error attach this validator’s Meta (innermost wins); on success apply the output conversion in meta().convert, if any.