1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
//!# 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: //!```toml //![dependencies] //!xlformula_engine = "0.1.3" //!``` //!and add this to your crate root: //!```rust //!extern crate xlformula_engine; //!``` //! //!## Examples //! //!Here are simple examples of parsing an Excel formula string and evaluating to a result: //!```rust //!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: //!```rust //!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 '=' ): //!```rust //!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: //!```rust //!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: //!```rust //!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: //!```rust //!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)); //!} //!``` #[macro_use] extern crate pest_derive; /// Evaluates a formula. pub mod calculate; /// The Structs and Enums for the calculation. pub mod types; /// Parses a string using `pest` and `pest::prec_climber`. pub mod parse_formula; pub type NoFormula<'a> = &'a fn(String) -> types::Value;