Enum jsl::errors::JslError

pub enum JslError {
    InvalidForm,
    AmbiguousProperty {
        property: String,
    },
    NoSuchDefinition {
        definition: String,
    },
    MaxDepthExceeded,
}

An enum of possible errors that can emerge from this crate.

Variants

InvalidForm

A schema-like object did not take on a valid form.

Only certain combinations of keywords make for valid JSL 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.

AmbiguousProperty

A schema-like object specified a keyword in an ambiguous manner.

JSL 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.

Fields of AmbiguousProperty

property: String

NoSuchDefinition

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.

Fields of NoSuchDefinition

definition: String

MaxDepthExceeded

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.

Trait Implementations

impl PartialEq<JslError> for JslError

fn eq(&self, other: &JslError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &JslError) -> bool

This method tests for !=.

impl Clone for JslError

fn clone(&self) -> JslError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for JslError

impl Display for JslError

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

Formats the value using the given formatter.

impl Debug for JslError

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

Formats the value using the given formatter.

impl Hash for JslError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Fail for JslError

fn name(&self) -> Option<&str>

Returns the "name" of the error.

fn cause(&self) -> Option<&dyn Fail>

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors.

fn backtrace(&self) -> Option<&Backtrace>

Returns a reference to the Backtrace carried by this failure, if it carries one.

fn context<D>(self, context: D) -> Context<D> where
    D: Display + Send + Sync + 'static, 

Provides context for this failure.

fn compat(self) -> Compat<Self>

Wraps this failure in a compatibility wrapper that implements std::error::Error.