Struct ShapeMismatch

pub struct ShapeMismatch {
    pub expected: Shape,
    pub received: Shape,
    pub path: Vec<NamedShapePathKey>,
}

The Shape::validate* methods return a vector of ShapeMismatch errors that is non-empty when validation fails.

Each ShapeMismatch error contains the expected shape, the received shape, and a path of NamedShapePathKey elements that leads from the root shape to the nested object/array location where the mismatch happened.

Conveniently, the expected/received terminology works for both the expected.accepts(received) and received.satisfies(expected) directions of comparison, so it doesn’t matter that ShapeMismatch errors happen to be generated by the internal satisfies_at_path method rather than by the validate method (which would also work).

Once issue #5 is implemented, you’ll be able to obtain source location information from the expected and received shapes (instead of adding additional fields to the ShapeMismatch struct).

Fields

expected: Shape

received: Shape

path: Vec<NamedShapePathKey>

Trait Implementations

impl Clone for ShapeMismatch

fn clone(&self) -> ShapeMismatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeMismatch

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

Formats the value using the given formatter.

impl Hash for ShapeMismatch

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ShapeMismatch

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ShapeMismatch

impl StructuralPartialEq for ShapeMismatch