Crate xlformula_engine

XLFormula Engine

XLFormula Engine is a Rust crate for parsing and evaluating Excel formulas. It currently works with f32 types.

Features

It supports:

• Any numbers, negative and positive, as float or integer;
• Arithmetic operations +, -, /, *, ^;
• Logical operations AND(), OR(), NOT(), XOR();
• Comparison operations =, >, >=, <, <=, <>;
• String operation & (concatenation);
• Build-in variables TRUE, FALSE;
• Excel functions ABS(), SUM(), PRODUCT().

Installation

Add the corresponding entry to your Cargo.toml dependency list:

[dependencies]
xlformula_engine = "0.1.3"

and add this to your crate root:

extern crate xlformula_engine;

Examples

Here are simple examples of parsing an Excel formula string and evaluating to a result:

extern crate xlformula_engine;
use xlformula_engine::calculate;
use xlformula_engine::parse_formula;
use xlformula_engine::NoFormula;

fn main() {
let formula = parse_formula::parse_string_to_formula(&"=1+2");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"=(1*(2+3))*2");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"=1+3/0"); // error (#DIV/0!)
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));
}

The last string is evaluated to #DIV/0!.

Concatenating strings:

extern crate xlformula_engine;
use xlformula_engine::calculate;
use xlformula_engine::parse_formula;
use xlformula_engine::NoFormula;

fn main() {
let formula = parse_formula::parse_string_to_formula(&"=\"Hello \" & \" World!\"");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"=1 + \"Hello\""); // error (#CAST!)
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));
}

Concatenating number and string results in a #CAST! error.

Constants ( i.e. a string without '=' ):

extern crate xlformula_engine;
use xlformula_engine::calculate;
use xlformula_engine::parse_formula;
use xlformula_engine::NoFormula;

fn main() {
let formula = parse_formula::parse_string_to_formula(&"1.2");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"Hello World");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));
}

Excel functions:

extern crate xlformula_engine;
use xlformula_engine::calculate;
use xlformula_engine::parse_formula;
use xlformula_engine::NoFormula;

fn main() {
let formula = parse_formula::parse_string_to_formula(&"=ABS(-1)");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"=SUM(1,2,\"3\")");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"=PRODUCT(ABS(1),2*1, 3,4*1)");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));
}

Logical expressions:

extern crate xlformula_engine;
use xlformula_engine::calculate;
use xlformula_engine::parse_formula;
use xlformula_engine::NoFormula;

fn main() {
let formula = parse_formula::parse_string_to_formula(&"=2>=1");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"=OR(1>1,1<>1)");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));

let formula = parse_formula::parse_string_to_formula(&"=AND(\"test\",\"True\", 1, true) ");
let result = calculate::calculate_formula(formula, None::<NoFormula>);
println!("Result is {}", calculate::result_to_string(result));
}

References:

extern crate xlformula_engine;
use xlformula_engine::calculate;
use xlformula_engine::parse_formula;
use xlformula_engine::types;

fn main() {
let data_function = |s: String| match s.as_str() {
"A" => types::Value::Text("=1+B".to_string()),
"B" => types::Value::Number(3.0),
_ => types::Value::Error(types::Error::Value),
};
let formula = parse_formula::parse_string_to_formula(&"=A+B");
let result = calculate::calculate_formula(formula, Some(&data_function));
println!("Result is {}", calculate::result_to_string(result));
}

Modules

calculate	Evaluates a formula.
parse_formula	Parses a string using pest and pest::prec_climber.
types	The Structs and Enums for the calculation.

Type Definitions

NoFormula