Enum ErrorKind 

#[non_exhaustive]
pub enum ErrorKind {
    Syntax,
    Io,
    Budget,
    Policy,
    KeyCollision,
    DuplicateKey,
    EndOfStream,
    Data,
    Other,
}

Coarse-grained classification of an Error, exposed for callers that need to route errors without pattern-matching every variant. Prefer this over inventing per-variant boolean accessors (is_syntax(), is_io(), …): one classifier scales as new variants land under Error’s #[non_exhaustive] attribute.

This enum is itself #[non_exhaustive] so future variants (e.g. a dedicated Timeout kind) can be added without a semver break.

Examples

use noyalib::{from_str, ErrorKind, Value};
let err = from_str::<Value>("1: a\n\"1\": b\n").unwrap_err();
assert_eq!(err.kind(), ErrorKind::KeyCollision);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Syntax

The document was malformed: unterminated flow collection, bad indentation, invalid escape, unexpected token, etc.

Io

An I/O operation failed while reading the input.

Budget

A configurable DoS budget or hard security limit was exceeded (recursion depth, alias expansion, mapping size, merge-key count, …). Covers every Error::Budget breach as well as Error::RecursionLimitExceeded and Error::RepetitionLimitExceeded.

Policy

A user-supplied crate::policy::Policy rejected the document, or a policy-only structural rule (merge-value shape, scalar-in-merge) tripped.

KeyCollision

Two distinct-typed YAML keys collapsed to the same string key — see Error::KeyCollision.

DuplicateKey

A genuine duplicate key was refused under crate::DuplicateKeyPolicy::Error.

EndOfStream

The parser reached end-of-stream where more input was required.

Data

The document parsed but the requested target type could not be built (missing field, unknown field, type mismatch, bad tag, unknown anchor, …). Covers the whole serde-facing “shape doesn’t match” family.

Other

The error came in via Error::Custom or Error::Message (usually from a serde_core::de::Error bridge) and doesn’t map cleanly to any of the other kinds.

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorKind

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Eq for ErrorKind

impl Hash for ErrorKind

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 ErrorKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ErrorKind