Enum Category

#[non_exhaustive]
pub enum Category {
    Io,
    Syntax,
    TypeUnmatched,
    NotFound,
    Eof,
}

Categorizes the cause of a sonic_rs::Error.

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.

Io

The error was caused by a failure to read or write bytes on an I/O stream. TODO: support stream reader in the future

Syntax

The error was caused by input that was not syntactically valid JSON.

TypeUnmatched

The error was caused when the input data is unmatched for expected type.

For example, JSON containing a number when the type being deserialized into holds a String.

NotFound

The error was caused when the target field was not found from JSON.

For example: When using get* APIs, it gets a unknown keys from JSON text, or get a index out of the array.

Eof

The error was caused by prematurely reaching the end of the input data.

Callers that process streaming input may be interested in retrying the deserialization once more data is available.

Trait Implementations

impl Clone for Category

fn clone(&self) -> Category

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Category

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

Formats the value using the given formatter.

impl PartialEq for Category

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

impl Eq for Category

impl StructuralPartialEq for Category