Enum JsonTopLevelKind 

#[non_exhaustive]
pub enum JsonTopLevelKind {
    Object,
    Array,
    Other,
}

Represents the top-level kind of a parsed JSON value.

The decoder uses this type to report whether the parsed value is an object, an array, or any other scalar-like JSON value.

Examples

#![deny(unused_must_use)]
use qubit_json::JsonTopLevelKind;

fn top_level_kind() -> JsonTopLevelKind {
    JsonTopLevelKind::Other
}

top_level_kind();

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.

Object

Indicates that the parsed top-level value is a JSON object.

Array

Indicates that the parsed top-level value is a JSON array.

Other

Indicates that the parsed top-level value is neither an object nor an array.

Implementations

impl JsonTopLevelKind

pub fn of(value: &Value) -> Self

Classifies the top-level kind of value.

This helper is used internally by constrained decode methods and may also be useful to callers inspecting decoded Value instances.

Parameters

• value - JSON value to classify.

Returns

Self::Object for objects, Self::Array for arrays, and Self::Other for scalar-like values.

Trait Implementations

impl Clone for JsonTopLevelKind

fn clone(&self) -> JsonTopLevelKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for JsonTopLevelKind

impl Debug for JsonTopLevelKind

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

Formats the value using the given formatter.

impl Display for JsonTopLevelKind

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

Writes the stable lowercase name of this top-level kind.

Parameters

• f - Destination formatter.

Returns

Ok(()) when the kind name is written successfully.

Errors

Returns a formatting error when the destination rejects the write.

impl Eq for JsonTopLevelKind

impl From<&Value> for JsonTopLevelKind

fn from(value: &Value) -> Self

Classifies a borrowed dynamic JSON value.

Parameters

• value - JSON value to classify.

Returns

The value’s coarse top-level kind.

impl FromStr for JsonTopLevelKind

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a top-level kind name without ASCII case sensitivity.

Parameters

• value - Kind name to parse.

Returns

The matching top-level kind.

Errors

Returns a static diagnostic when value is not a known kind name.

type Err = &'static str

The associated error which can be returned from parsing.

impl Hash for JsonTopLevelKind

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 JsonTopLevelKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for JsonTopLevelKind