Enum rsonpath::result::NodeTypeHint

#[non_exhaustive]
pub enum NodeTypeHint {
    Atomic,
    Complex(BracketType),
    AnyComplex,
    Any,
}

Hint given by the engine to a QueryResultBuilder as to what type of node was matched.

Since the byte offset given by the engine is not stable and can fall anywhere between the actual value’s start and the preceding structural character, this helps a builder quickly advance to the actual value and parse it.

This is non_exhaustive, since we may add more hints for performance reasons, and the implementations are already forced to handle the Any variant. The behavior for “unknown” hints should be the same as for Any.

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.

Atomic

The value is any atom (number, string, boolean, null).

Complex(BracketType)

The value is an object or an array, and we know what type of bracket to look for.

AnyComplex

The value is an object or an array, but we do not know which. The builder should seek for a ‘{’ or ‘[’.

Any

The value can be any JSON value, we know nothing more.

Trait Implementations

impl Clone for NodeTypeHint

fn clone(&self) -> NodeTypeHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeTypeHint

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

Formats the value using the given formatter.

impl Hash for NodeTypeHint

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<NodeTypeHint> for NodeTypeHint

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for NodeTypeHint

impl Eq for NodeTypeHint

impl StructuralEq for NodeTypeHint

impl StructuralPartialEq for NodeTypeHint