Struct SchemaErrors 

pub struct SchemaErrors(/* private fields */);

A non-empty collection of schema validation errors.

SchemaErrors wraps a NonEmptyVec<SchemaError> to guarantee that at least one error is present. This is essential for use with Validation<T, SchemaErrors> since a failure must have at least one error.

Combining Errors

SchemaErrors implements Semigroup, allowing errors from multiple validations to be combined:

use postmortem::{JsonPath, SchemaError, SchemaErrors};
use stillwater::prelude::*;

let errors1 = SchemaErrors::single(
    SchemaError::new(JsonPath::root().push_field("name"), "required")
);
let errors2 = SchemaErrors::single(
    SchemaError::new(JsonPath::root().push_field("email"), "invalid format")
);

let combined = errors1.combine(errors2);
assert_eq!(combined.len(), 2);

Implementations

impl SchemaErrors

pub fn single(error: SchemaError) -> Self

Creates a SchemaErrors containing a single error.

pub fn from_non_empty(errors: NonEmptyVec<SchemaError>) -> Self

Creates a SchemaErrors from a NonEmptyVec of errors.

pub fn len(&self) -> usize

Returns the number of errors in this collection.

pub fn is_empty(&self) -> bool

Returns false since this collection is guaranteed non-empty.

This method exists for API consistency but always returns false.

pub fn iter(&self) -> impl Iterator<Item = &SchemaError>

Returns an iterator over the contained errors.

pub fn at_path(&self, path: &JsonPath) -> Vec<&SchemaError>

Returns all errors at the specified path.

pub fn with_code(&self, code: &str) -> Vec<&SchemaError>

Returns all errors with the specified error code.

pub fn first(&self) -> &SchemaError

Returns the first error in the collection.

pub fn into_vec(self) -> Vec<SchemaError>

Converts this collection into a Vec<SchemaError>.

pub fn as_non_empty_vec(&self) -> &NonEmptyVec<SchemaError>

Returns a reference to the underlying NonEmptyVec.

pub fn from_vec(errors: Vec<SchemaError>) -> Self

Creates a SchemaErrors from a Vec<SchemaError>.

Returns the SchemaErrors if the vec is non-empty, or panics if empty. Use this when you’re certain the vec contains at least one error.

Panics

Panics if the provided vec is empty.

Trait Implementations

impl Clone for SchemaErrors

fn clone(&self) -> SchemaErrors

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaErrors

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

Formats the value using the given formatter.

impl Display for SchemaErrors

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

Formats the value using the given formatter.

impl Error for SchemaErrors

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<'a> IntoIterator for &'a SchemaErrors

type Item = &'a SchemaError

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a SchemaError> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for SchemaErrors

type Item = SchemaError

The type of the elements being iterated over.

type IntoIter = IntoIter<SchemaError>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for SchemaErrors

fn eq(&self, other: &SchemaErrors) -> 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 Semigroup for SchemaErrors

fn combine(self, other: Self) -> Self

Combine this value with another value associatively

impl StructuralPartialEq for SchemaErrors