Struct CompiledSchemaBuilder 

pub struct CompiledSchemaBuilder { /* private fields */ }

Configures a CompiledSchema before compilation. Created by CompiledSchema::builder.

Implementations

impl CompiledSchemaBuilder

pub fn validate_formats(self, yes: bool) -> Self

Assert format keywords instead of treating them as annotations. Under Draft 2020-12 the default is annotation-only, so format: date accepts 01/15/2024 unless this is on.

pub fn with_format<N, F>(self, name: N, check: F) -> Self

where N: Into<String>, F: Fn(&str) -> bool + Send + Sync + 'static,

Register a custom format checker for format: <name>. Implies nothing about assertion — combine with Self::validate_formats to have the checker enforced.

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

Collect at most n violations per validation (default DEFAULT_MAX_SCHEMA_ERRORS). The total found is still reported.

pub fn max_error_bytes(self, n: usize) -> Self

Collect at most n bytes of violation text per validation, summed over every message (default DEFAULT_MAX_SCHEMA_ERROR_BYTES).

pub fn max_schema_nodes(self, n: usize) -> Self

Refuse schemas with more than n JSON nodes (default DEFAULT_MAX_SCHEMA_NODES).

pub fn max_schema_depth(self, n: usize) -> Self

Refuse schemas whose arrays and objects nest deeper than n (default DEFAULT_MAX_SCHEMA_DEPTH).

pub fn backtracking_patterns(self, limit: usize) -> Self

Compile pattern and patternProperties with the backtracking engine, which supports lookaround and backreferences, and stop any single match after limit backtracking steps (a match that hits the limit is reported as a violation).

Off by default: the default engine runs in linear time. Only opt in for schemas from a trusted source, with a small limit.

Examples

use noyalib::{CompiledSchema, Value, from_str};

let schema: Value = from_str("type: string\npattern: '^(?!tmp)'\n").unwrap();
assert!(CompiledSchema::compile(&schema).is_err());
let compiled = CompiledSchema::builder(&schema)
    .backtracking_patterns(10_000)
    .build()
    .unwrap();
assert!(compiled.validate(&from_str("tmpfile").unwrap()).is_err());

pub fn build(self) -> Result<CompiledSchema>

Compile the schema with the accumulated configuration.

Errors

As CompiledSchema::compile, plus a schema over the node or depth limit.

Trait Implementations

impl Debug for CompiledSchemaBuilder

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

Formats the value using the given formatter.