Enum Warning 

pub enum Warning {
    UnexpectedField,
    NonSpecField,
    MissingField {
        name: &'static str,
    },
    NullField,
    InvalidType {
        expected: ValueKind,
        actual: ValueKind,
    },
    StringTooLong {
        max: usize,
        len: usize,
    },
    InvalidValue {
        expected: &'static [&'static str],
        actual: String,
    },
    IncorrectCase {
        expected: &'static str,
        actual: String,
    },
    Cardinality,
}

A structural problem found while validating a JSON document against the OCPI schema.

Variants

UnexpectedField

A field present in the JSON that the schema does not list.

NonSpecField

A field the spec for this version does not define, which this layer reads anyway because real-world documents carry it. The value is still validated and retained.

MissingField

A required field absent from its containing object.

Fields

name: &'static str

The field name the schema expected.

NullField

A field whose value is JSON null. null fields can simply be omitted.

InvalidType

A value whose JSON kind does not match the schema.

Fields

expected: ValueKind

The JSON kind the schema expects.

actual: ValueKind

The JSON kind encountered.

StringTooLong

A string longer than the maximum length the schema permits.

Fields

max: usize

The maximum character length the schema allows.

len: usize

The character length actually encountered.

InvalidValue

A string value that is not one of an enum field’s permitted variants, read without regard to case.

Fields

expected: &'static [&'static str]

The permitted spec values, in the spec’s defined case.

actual: String

The value encountered, as written in the JSON (escapes not decoded).

IncorrectCase

A string value that names one of an enum field’s variants, but not in the spec’s case.

Both OCPI versions state that strings in messages and enumerations are case-sensitive, so the value is off-spec rather than merely unconventional. This crate reads it anyway, and says which variant it read.

Fields

expected: &'static str

The variant the value named, in the spec’s defined case.

actual: String

The value encountered, as written in the JSON (escapes not decoded).

Cardinality

An empty array for a field whose schema requires one or more elements.

The only cardinality the schema can violate is “one or more”, and the only way to violate it is to hold nothing, so this variant carries no data.

Trait Implementations

impl Clone for Warning

fn clone(&self) -> Warning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Warning

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

Formats the value using the given formatter.

impl Display for Warning

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

Formats the value using the given formatter.

impl Eq for Warning

impl Fixable for Warning

fn fix(&self, element: &Element<'_>) -> Option<Edit>

The edit that resolves this warning at element, or None if nothing mechanical can resolve it.

impl PartialEq for Warning

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Warning

impl Warning for Warning

fn id(&self) -> Id

Return the human readable identifier for the Warning.

fn is_rejected(&self) -> bool

Whether this is the Rejected marker a feature emits when it rejects the schema IR for the object it is building.