jsonschema-valid 0.5.2

A simple JSON schema validator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

use serde_json::Value;

use crate::context::Context;
use crate::error::{ErrorIterator, ValidationError};
use crate::format::FormatChecker;
use crate::resolver::Resolver;
use crate::schemas;
use crate::validators;
use crate::validators::Validator;

/// A structure to hold configuration for a validation run.
pub struct Config<'a> {
    schema: &'a Value,
    resolver: Resolver<'a>,
    pub(crate) draft: schemas::Draft,
}

impl<'a> Config<'a> {
    /// Get the validator object for the draft in use.
    pub fn get_validator<'v>(&self, key: &'v str) -> Option<Validator<'v>> {
        self.draft.get_validator(key)
    }

    /// Get the string format checker for the draft in use.
    pub fn get_format_checker(&self, key: &str) -> Option<FormatChecker> {
        self.draft.get_format_checker(key)
    }

    /// Get the draft number in use.
    pub fn get_draft_number(&self) -> u8 {
        self.draft.get_draft_number()
    }

    /// Get the metaschema associated with the draft in use.
    pub fn get_metaschema(&self) -> &Value {
        self.draft.get_schema()
    }

    /// Get the resolver for the parsing context.
    pub fn get_resolver(&self) -> &Resolver<'a> {
        &self.resolver
    }

    /// Get the schema currently being checked against.
    pub fn get_schema(&self) -> &Value {
        self.schema
    }

    /// Create a new Config object from a given schema.
    ///
    /// Will use the Draft of JSON schema specified by `draft`. If `draft` is
    /// `None`, it will be automatically determined from the `$schema` entry in
    /// the given `schema`. If no `$schema` entry is present Draft 7 will be used
    /// by default.
    pub fn from_schema(
        schema: &'a Value,
        draft: Option<schemas::Draft>,
    ) -> Result<Config<'a>, ValidationError> {
        let draft = draft.unwrap_or_else(|| {
            schemas::draft_from_schema(schema).unwrap_or(schemas::Draft::Draft7)
        });
        Ok(Config {
            schema,
            resolver: Resolver::from_schema(draft, schema)?,
            draft,
        })
    }

    /// Validate the given JSON instance against the schema.
    pub fn validate(&'a self, instance: &'a Value) -> Result<(), ErrorIterator<'a>> {
        crate::validate(self, instance)
    }

    /// Validate the schema in this Config object against the metaschema.
    pub fn validate_schema(&'a self) -> Result<(), ErrorIterator<'a>> {
        let mut errors = validators::descend(
            self,
            self.get_schema(),
            self.get_metaschema(),
            None,
            Context::new_from(self.get_metaschema()),
        )
        .peekable();

        if errors.peek().is_none() {
            Ok(())
        } else {
            Err(Box::new(errors))
        }
    }
}