Struct ValidateOptions

pub struct ValidateOptions { /* private fields */ }

Options you can pass to validate().

Implementations

impl ValidateOptions

pub fn new() -> Self

Construct a new set of options with all default values.

Equivalent to Default::default() or calling with_max_depth(0) and with_max_errors(0).

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

Sets the maximum “depth” of references to following in validate().

This option exists to handle the possibility of an infinite loop in a schema. For instance, this is a valid schema:

{ "ref": "loop", "definitions": { "loop": { "ref": "loop" }}}

There are good reasons to sometimes have self-referential schemas – for instance, to describe a recursive data structure. What with_max_depth does is limit how many recursive ref nodes will be followed before validate() errors with ValidateError::MaxDepthExceeded.

The default max depth of 0 indicates that no max depth should be implemented. An infinite ref loop will eventually overflow the stack during validate().

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

Sets the maximum number of validation errors to return from validate().

This option exists as an optimization for validate(). If all you care about is whether an input is valid, then consider using set_max_errors(1) to have validate() immediately return after finding a validation error.

The default max errors of 0 indicates that all errors will be returned.

Trait Implementations

impl Clone for ValidateOptions

fn clone(&self) -> ValidateOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidateOptions

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

Formats the value using the given formatter.

impl Default for ValidateOptions

fn default() -> ValidateOptions

Returns the “default value” for a type.

impl PartialEq for ValidateOptions

fn eq(&self, other: &ValidateOptions) -> 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 Eq for ValidateOptions

impl StructuralPartialEq for ValidateOptions