Interface Function

graphlite/src/functions/function_trait.rs:109–142

Core trait for all functions - just implement this for any function

/// Core trait for all functions - just implement this for any function
pub trait Function: Send + Sync + std::fmt::Debug {
    /// Get the name of the function
    #[allow(dead_code)] // ROADMAP v0.5.0 - Function metadata for introspection (see ROADMAP.md §8)
    fn name(&self) -> &str;

    /// Get the function description
    #[allow(dead_code)] // ROADMAP v0.5.0 - Function metadata for introspection (see ROADMAP.md §8)
    fn description(&self) -> &str;

    /// Get the expected number of arguments
    #[allow(dead_code)] // ROADMAP v0.5.0 - Function metadata for introspection (see ROADMAP.md §8)
    fn argument_count(&self) -> usize;

    /// Execute the function with the given context
    fn execute(&self, context: &FunctionContext) -> FunctionResult<Value>;

    /// Get the return type of the function
    #[allow(dead_code)] // ROADMAP v0.5.0 - Function metadata for introspection (see ROADMAP.md §8)
    fn return_type(&self) -> &str;

    /// Check if this function requires graph context to execute
    /// Most functions that work with variables, properties, or graph data require context.
    /// Pure scalar functions (math, string manipulation, timezone) do not.
    fn graph_context_required(&self) -> bool {
        true // Default to requiring context for safety
    }

    /// Check if this function accepts a variable number of arguments
    /// Returns true for functions like ALL_DIFFERENT that can take any number of args
    #[allow(dead_code)] // ROADMAP v0.5.0 - Function metadata for introspection (see ROADMAP.md §8)
    fn is_variadic(&self) -> bool {
        false // Default to fixed argument count
    }
}