ganit-core

Spreadsheet formula engine — parser and evaluator for Excel-compatible formulas.

Also available as a WebAssembly npm package: @tryganit/core

Install

[dependencies]
ganit-core = "0.1"

Or via cargo:

cargo add ganit-core

Usage

Evaluate a formula

use std::collections::HashMap;
use ganit_core::{evaluate, Value};

let mut vars = HashMap::new();
vars.insert("A1".to_string(), Value::Number(100.0));
vars.insert("B1".to_string(), Value::Number(200.0));

let result = evaluate("SUM(A1, B1)", &vars);
assert_eq!(result, Value::Number(300.0));

Pattern match on the result

use std::collections::HashMap;
use ganit_core::{evaluate, Value};

let mut vars = HashMap::new();
vars.insert("score".to_string(), Value::Number(85.0));

match evaluate("IF(score >= 60, \"pass\", \"fail\")", &vars) {
    Value::Text(s)   => println!("{s}"),           // "pass"
    Value::Number(n) => println!("{n}"),
    Value::Bool(b)   => println!("{b}"),
    Value::Error(e)  => eprintln!("formula error: {e}"),
    Value::Empty     => println!("(empty)"),
    Value::Array(_)  => println!("(array)"),
}

Validate without evaluating

use ganit_core::validate;

match validate("SUM(A1, B1)") {
    Ok(_)  => println!("valid"),
    Err(e) => eprintln!("parse error at position {}: {}", e.position, e.message),
}

Parse to an AST

use ganit_core::parse;

let expr = parse("1 + 2 * 3").expect("valid formula");
// expr is an Expr tree you can walk yourself

Types

Value

ErrorKind

Available functions

Covers math, logical, text, financial, and statistical categories. For the full list with signatures and descriptions, query the live registry:

use ganit_core::Registry;

let registry = Registry::new();
for (name, meta) in registry.list_functions() {
    println!("{} ({}): {}", name, meta.category, meta.description);
}

License

MIT