Struct jsl::validator::Config

pub struct Config { /* fields omitted */ }

Configuration for how validation should proceed.

Methods

impl Config

pub fn new() -> Self

Create a new, default Config.

pub fn max_errors(&mut self, max_errors: usize) -> &mut Self

Sets the maximum number of errors to produce before stopping validation. 0, the default value, indicates that all errors should be produced.

If your use-case doesn't care about errors, and you just want to abort on the first error, you should set this value to 1.

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

Sets the maximum call depth before aborting evaluation. The default value is to follow 32 cross-references before aborting.

When evaluation is aborted because of this maximum depth, validation fails. No validation errors are returned.

This functionality exists to support detecting infinite loops in schemas, for example in circularly-defined schemas.

pub fn strict_instance_semantics(
    &mut self,
    strict_instance_semantics: bool
) -> &mut Self

Sets whether to use strict instance semantics. The default is to not use strict instance semantics.

Essentially, strict instance semantics determines whether it's ok for an instance (input) to have properties not mentioned in a schema. When using strict instance semantics, these undeclared properties will be considered erroneuous. In non-strict instance semantics, these properties are simply ignored.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.