Struct FunctionDetail 

pub struct FunctionDetail {
    pub name: String,
    pub category: String,
    pub description: String,
    pub signature: String,
    pub example: String,
    pub is_standard: bool,
    pub jep: Option<String>,
    pub aliases: Vec<String>,
}

Detailed information about a JMESPath function.

This struct provides a serializable representation of function metadata, suitable for API responses, documentation generation, and introspection tools.

Example

use jpx_engine::JpxEngine;

let engine = JpxEngine::new();
let info = engine.describe_function("upper").unwrap();

println!("Function: {}", info.name);
println!("Category: {}", info.category);
println!("Signature: {}", info.signature);
println!("Example: {}", info.example);

Fields

name: String

Function name (e.g., “upper”, “sum”, “now”)

category: String

Category name (e.g., “String”, “Math”, “Datetime”)

description: String

Human-readable description of what the function does

signature: String

Function signature showing parameter types (e.g., “string -> string”)

example: String

Example usage demonstrating the function

is_standard: bool

Whether this is a standard JMESPath function (vs extension)

jep: Option<String>

JMESPath Enhancement Proposal number, if applicable

aliases: Vec<String>

Alternative names for this function

Trait Implementations

impl Clone for FunctionDetail

fn clone(&self) -> FunctionDetail

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDetail

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionDetail

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&FunctionInfo> for FunctionDetail

fn from(info: &FunctionInfo) -> Self

Converts to this type from the input type.

impl Serialize for FunctionDetail

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

where __S: Serializer,

Serialize this value into the given Serde serializer.