pub struct FunctionInfo {
pub name: &'static str,
pub category: Category,
pub description: &'static str,
pub signature: &'static str,
pub example: &'static str,
pub is_standard: bool,
pub jep: Option<&'static str>,
pub aliases: &'static [&'static str],
pub features: &'static [Feature],
}Expand description
Metadata about a function
Fields§
§name: &'static strFunction name as used in JMESPath expressions
category: CategoryCategory this function belongs to
description: &'static strHuman-readable description
signature: &'static strArgument signature (e.g., “string, string -> string”)
example: &'static strExample usage
is_standard: boolWhether this is a standard JMESPath function (vs extension)
jep: Option<&'static str>JMESPath Enhancement Proposal reference (e.g., “JEP-014”) See: https://github.com/jmespath-community/jmespath.spec
aliases: &'static [&'static str]Alternative names for this function (e.g., “some” for “any_expr”)
features: &'static [Feature]Feature tags for classification (e.g., “fp”, “core”)
Trait Implementations§
Source§impl Clone for FunctionInfo
impl Clone for FunctionInfo
Source§fn clone(&self) -> FunctionInfo
fn clone(&self) -> FunctionInfo
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for FunctionInfo
impl Debug for FunctionInfo
Source§impl From<&FunctionInfo> for FunctionDetail
impl From<&FunctionInfo> for FunctionDetail
Source§fn from(info: &FunctionInfo) -> Self
fn from(info: &FunctionInfo) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl Freeze for FunctionInfo
impl RefUnwindSafe for FunctionInfo
impl Send for FunctionInfo
impl Sync for FunctionInfo
impl Unpin for FunctionInfo
impl UnwindSafe for FunctionInfo
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more