Struct jsonschema::JSONSchema

pub struct JSONSchema<'a> { /* fields omitted */ }

The structure that holds a JSON Schema compiled into a validation tree

Implementations

impl<'a> JSONSchema<'a>

pub fn options() -> CompilationOptions

Return a default CompilationOptions that can configure JSONSchema compilaton flow.

Using options you will be able to configure the draft version to use during JSONSchema compilation

Example of usage:

let maybe_jsonschema: Result<JSONSchema, _> = JSONSchema::options()
    .with_draft(Draft::Draft7)
    .compile(&schema);

pub fn compile(schema: &'a Value) -> Result<JSONSchema<'a>, CompilationError>

Compile the input schema into a validation tree.

The method is equivalent to JSONSchema::options().compile(schema)

pub fn validate(&'a self, instance: &'a Value) -> Result<(), ErrorIterator<'a>>

Run validation against instance and return an iterator over ValidationError in the error case.

#[must_use]

pub fn is_valid(&self, instance: &Value) -> bool

Run validation against instance but return a boolean result instead of an iterator. It is useful for cases, where it is important to only know the fact if the data is valid or not. This approach is much faster, than validate.

Trait Implementations

impl<'a> Debug for JSONSchema<'a>

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

Formats the value using the given formatter.