Enum BuiltinFunction 

pub enum BuiltinFunction {
    Math(MathFunction),
    String(StringFunction),
    Regex(RegexFunction),
    Aggregate(AggregateFunction),
    Conversion(ConversionFunction),
    DateTime(DateTimeFunction),
    Geography(GeographyFunction),
    Utility(UtilityFunction),
    Graph(GraphFunction),
    Container(ContainerFunction),
    Path(PathFunction),
    Fulltext(FulltextFunction),
    Vector(VectorFunction),
    Window(WindowFunction),
    Sequence(SequenceFunction),
}

Built-in function types to avoid dynamic distribution.

Variants

Math(MathFunction)

Mathematical functions

String(StringFunction)

String functions

Regex(RegexFunction)

Regular Expression Functions

Aggregate(AggregateFunction)

Aggregate functions

Conversion(ConversionFunction)

Type conversion functions

DateTime(DateTimeFunction)

Date and time functions

Geography(GeographyFunction)

Geospatial functions

Utility(UtilityFunction)

Practical functions

Graph(GraphFunction)

Graph-related functions

Container(ContainerFunction)

Container operation functions

Path(PathFunction)

Path function

Fulltext(FulltextFunction)

Full-text search functions

Vector(VectorFunction)

Vector functions

Window(WindowFunction)

Window functions

Sequence(SequenceFunction)

Sequence functions (curr_val, next_val)

Implementations

impl BuiltinFunction

pub fn name(&self) -> &str

Get function name

pub fn arity(&self) -> usize

Get the number of parameters

pub fn is_variadic(&self) -> bool

Check if variable parameters are accepted

pub fn is_pure(&self) -> bool

Whether the function is deterministic and free of side effects.

Purity gates constant folding: a function classified as pure may be evaluated once at plan time and its result baked into the plan as a literal. Classifying a non-deterministic or context-dependent function as pure would fold a stale result into a (possibly cached) plan, so the classification is a whitelist: categories that are pure for every variant return true; mixed categories enumerate the pure variants explicitly; anything not listed — including future variants — defaults to false.

Never folded:

• non-deterministic: rand*, now, timestamp, current_date, current_timestamp, gen_random_uuid
• session-dependent: current_user, current_database (currently stubbed, but conceptually per-session)
• need row-group / storage / index context: aggregates, window functions, graph functions, fulltext search, vector functions

pub fn description(&self) -> &str

Get function description

pub fn execute(&self, args: &[Value]) -> Result<Value, ExpressionError>

executable function

pub fn execute_with_storage( &self, args: &[Value], storage: &GraphStorageRef, ) -> Result<Value, ExpressionError>

Execute function with graph storage access. Graph functions use this to perform storage-backed operations.

pub fn execute_with_cache( &self, args: &[Value], _cache: &mut (), ) -> Result<Value, ExpressionError>

Execution function (with cache)

The caching function has been removed; this method directly calls execute.

Trait Implementations

impl Clone for BuiltinFunction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltinFunction

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

Formats the value using the given formatter.

impl ExpressionFunction for BuiltinFunction

fn name(&self) -> &str

Obtain the function name

fn arity(&self) -> usize

Determine the number of parameters

fn is_variadic(&self) -> bool

Check whether variable parameters are accepted.

fn execute(&self, args: &[Value]) -> Result<Value, ExpressionError>

Execute the function

fn description(&self) -> &str

Obtain the function description