expressive/README.md

108 lines
2.1 KiB
Markdown
Raw Normal View History

2016-11-16 16:12:26 +00:00
eval
===
2016-11-21 01:14:40 +00:00
[![docs](https://docs.rs/eval/badge.svg?version=0.2.1 "docs")](https://docs.rs/eval)
2016-11-16 16:31:52 +00:00
2016-11-18 04:03:03 +00:00
Eval is a powerful expression evaluator.
2016-11-16 16:12:26 +00:00
2016-11-16 16:31:52 +00:00
## [Document](https://docs.rs/eval)
2016-11-16 16:12:26 +00:00
## Features
Supported operators: `!` `!=` `""` `''` `()` `[]` `,` `>` `<` `>=` `<=` `==`
`+` `-` `*` `/` `%` `&&` `||` `n..m`.
Built-in functions: `min()` `max()` `len()` `is_empty()`.
2016-11-16 16:12:26 +00:00
## Where can eval be used?
* Template engine
* ...
## Usage
Add dependency to Cargo.toml
```toml
[dependencies]
eval = "^0.2"
2016-11-16 16:12:26 +00:00
```
In your `main.rs` or `lib.rs`:
```rust
extern crate eval;
```
## Examples
You can do mathematical calculations with supported operators:
```
use eval::{eval, to_value};
assert_eq!(eval("1 + 2 + 3"), Ok(to_value(6)));
assert_eq!(eval("2 * 2 + 3"), Ok(to_value(7)));
assert_eq!(eval("2 / 2 + 3"), Ok(to_value(4.0)));
assert_eq!(eval("2 / 2 + 3 / 3"), Ok(to_value(2.0)));
```
You can eval with context:
```
use eval::{Expr, to_value};
2016-11-16 16:12:26 +00:00
assert_eq!(Expr::new("foo == bar")
.value("foo", true)
.value("bar", true)
.exec(),
Ok(to_value(true)));
2016-11-16 16:12:26 +00:00
```
2016-11-21 01:14:40 +00:00
You can access data like javascript by using `.` and `[]`. `[]` supports expression.
```
use eval::{Expr, to_value};
use std::collections::HashMap;
let mut object = HashMap::new();
object.insert("foos", vec!["Hello", "world", "!"]);
assert_eq!(Expr::new("object.foos[1-1] == 'Hello'")
.value("object", object)
.exec(),
Ok(to_value(true)));
```
You can eval with function:
2016-11-16 16:12:26 +00:00
```
use eval::{Expr, to_value};
2016-11-16 16:12:26 +00:00
assert_eq!(Expr::new("say_hello()")
.function("say_hello", |_| Ok(to_value("Hello world!")))
.exec(),
Ok(to_value("Hello world!")));
2016-11-16 16:12:26 +00:00
```
2016-11-21 01:14:40 +00:00
2016-11-16 16:12:26 +00:00
You can create an array with `[]`:
```
use eval::{eval, to_value};
assert_eq!(eval("[1, 2, 3, 4, 5]"), Ok(to_value(vec![1, 2, 3, 4, 5])));
```
2016-11-21 01:14:40 +00:00
2016-11-16 16:12:26 +00:00
You can create an integer array with `n..m`:
```
use eval::{eval, to_value};
assert_eq!(eval("0..5"), Ok(to_value(vec![0, 1, 2, 3, 4])));
```
## License
eval is primarily distributed under the terms of the MIT license.
See [LICENSE](LICENSE) for details.