jeff/expressive
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update aggregation operator documentation

Browse Source 
Relates to #44
This commit is contained in:
Sebastian Schmidt 2019-08-30 09:16:08 +03:00
parent 03a30205e2
commit 4571f3a578
2 changed files with 38 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -166,14 +166,30 @@ Supported unary operators:
#### The Aggregation Operator
The aggregation operator aggregates two values into a tuple.
If one of the values is a tuple already, the resulting tuple will be flattened.
The aggregation operator aggregates a set of values into a tuple.
A tuple can contain arbitrary values, it is not restricted to a single type.
The operator is n-ary, so it supports creating tuples longer than length two.
Example:
```rust
use evalexpr::*;
assert_eq!(eval("1, 2, 3"), Ok(Value::from(vec![Value::from(1), Value::from(2), Value::from(3)])));
assert_eq!(eval("1, \"b\", 3"), Ok(Value::from(vec![Value::from(1), Value::from("b"), Value::from(3)])));
```
To create nested tuples, use parentheses:
```rust
use evalexpr::*;
assert_eq!(eval("1, 2, (true, \"b\")"), Ok(Value::from(vec![
Value::from(1),
Value::from(2),
Value::from(vec![
Value::from(true),
Value::from("b")
])
])));
```
#### The Assignment Operator

22
src/lib.rs
View File

@ -153,14 +153,30 @@
//!
//! #### The Aggregation Operator
//!
//! The aggregation operator aggregates two values into a tuple.
//! If one of the values is a tuple already, the resulting tuple will be flattened.
//! The aggregation operator aggregates a set of values into a tuple.
//! A tuple can contain arbitrary values, it is not restricted to a single type.
//! The operator is n-ary, so it supports creating tuples longer than length two.
//! Example:
//!
//! ```rust
//! use evalexpr::*;
//!
//! assert_eq!(eval("1, 2, 3"), Ok(Value::from(vec![Value::from(1), Value::from(2), Value::from(3)])));
//! assert_eq!(eval("1, \"b\", 3"), Ok(Value::from(vec![Value::from(1), Value::from("b"), Value::from(3)])));
//! ```
//!
//! To create nested tuples, use parentheses:
//!
//! ```rust
//! use evalexpr::*;
//!
//! assert_eq!(eval("1, 2, (true, \"b\")"), Ok(Value::from(vec![
//! Value::from(1),
//! Value::from(2),
//! Value::from(vec![
//! Value::from(true),
//! Value::from("b")
//! ])
//! ])));
//! ```
//!
//! #### The Assignment Operator