jddf 0.3.3

JSON Data Definition Format validator and utilities.
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

//! An error type for all JDDF-related operations.

use failure::Fail;

/// An enum of possible errors that can emerge from this crate.
#[derive(Debug, Fail, PartialEq, Clone, Eq, Hash)]
pub enum JddfError {
    /// A schema-like object did not take on a valid form.
    ///
    /// Only certain combinations of keywords make for valid JDDF schemas. When
    /// a schema uses an invalid combination of keywords, it is said to not take
    /// on one of the valid forms. Converting a `SerdeSchema` with an invalid
    /// combination of keywords into a `Schema` will result in this error.
    #[fail(display = "invalid schema form")]
    InvalidForm,

    /// A schema-like object specified a keyword in an ambiguous manner.
    ///
    /// JDDF prohibits schemas from specifying the same property twice in the
    /// same schema. This error arises when a `SerdeSchema`'s `properties`,
    /// `optionalProperties`, or `discriminator.propertyName` share a property
    /// in common, and one attempts to convert this into a `Schema`.
    #[fail(display = "ambiguous property: {}", property)]
    AmbiguousProperty { property: String },

    /// A schema refers to a definition which does not exist.
    ///
    /// Schemas may refer to one another using the `ref` keyword, which may refer
    /// to a `definition` in the root schema. If a schema refers to a definition
    /// which does not exist, this error is returned.
    #[fail(display = "no such definition: {}", definition)]
    NoSuchDefinition { definition: String },

    /// The maximum depth during evaluating was exceeded.
    ///
    /// This likely means that your configured `max_depth` is too small, or that
    /// there is a infinite cyclical definition in your schemas.
    #[fail(display = "maximum reference depth exceeeded during validation")]
    MaxDepthExceeded,
}