Struct ExplainResult 

pub struct ExplainResult {
    pub expression: String,
    pub steps: Vec<ExplainStep>,
    pub functions_used: Vec<String>,
    pub complexity: String,
}

Step-by-step breakdown of a JMESPath expression.

Returned by JpxEngine::explain.

Example

use jpx_engine::JpxEngine;

let engine = JpxEngine::new();
let result = engine.explain("users[?age > `30`].name | sort(@)").unwrap();

assert!(!result.steps.is_empty());
assert!(result.functions_used.contains(&"sort".to_string()));

Fields

expression: String

The original expression.

steps: Vec<ExplainStep>

Ordered steps describing what the expression does.

functions_used: Vec<String>

All function names used in the expression.

complexity: String

Rough complexity label: “simple”, “moderate”, or “complex”.

Trait Implementations

impl Clone for ExplainResult

fn clone(&self) -> ExplainResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExplainResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExplainResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.