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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
extern crate pest_derive;
extern crate pest;
use Parser;
use ;
use crateBoxedExpression;
/// **Create collection** <br>
/// `new({});` <br>
///
/// **Drop collection** <br>
/// `drop('');` <br>
///
/// **Check if pointer exists in collection** <br>
/// `exists('').into('');` <br>
///
/// **Length of collection** <br>
/// `length('');` <br>
///
/// **Update or Insert into collection** <br>
/// `put({}).into('');` <br>
///
/// **Conditional Update or Insert into collection** <br>
/// `put({}).when(:includes(array_filter('e.f$.g'),2):).into('');` <br>
///
/// **Update or Insert into collection to a Pointer** <br>
/// `put({}).pointer('').into('');` <br>
///
/// **Get from collection** <br>
/// `get.from('');` <br>
///
/// **Conditional Get from collection** <br>
/// `get.when(:includes(array_filter('e.f$.g'),2):).from('');` <br>
///
/// **Get Pointer from collection** <br>
/// `get.pointer('').from('');` <br>
///
/// **Get View from collection** <br>
/// `get.view('').from('');` <br>
///
/// **Get Clip from collection** <br>
/// `get.clip('').from('');` <br>
///
/// **Delete from collection** <br>
/// `delete.from('');` <br>
///
/// **Conditional Delete from collection** <br>
/// `delete.when(:includes(array_filter('e.f$.g'),2):).from('');` <br>
///
/// **Delete Pointer from collection** <br>
/// `delete.pointer('').from('');` <br>
///
/// **Delete View from collection** <br>
/// `delete.view('').from('');` <br>
///
/// **Delete Clip from collection** <br>
/// `delete.clip('').from('');` <br>
/// <br><br>
/// # Example
/// <br><br>
/// ```rust
/// use flql::{parse, Flql};
/// let commands = vec![
/// "new({});",
/// "drop('');",
/// "exists('').into('');",
/// "length('');",
/// "put({}).into('');",
/// "put({}).when('prop.name == \"acv\" OR prop.name STARTS_WITH \"ac\"').into('');",
/// "put({}).pointer('').into('');",
/// "get.from('');",
/// "get.when('prop.name == \"acv\" OR prop.name STARTS_WITH \"ac\"').from('');",
/// "get.pointer('').from('');",
/// "get.view('').from('');",
/// "get.clip('').from('');",
/// "delete.from('');",
/// "delete.when('prop.name == \"acv\" OR prop.name STARTS_WITH \"ac\"').from('');",
/// "delete.pointer('').from('');",
/// "delete.clip('').from('');"
/// ];
/// for command in commands {
/// let chk = parse(command);
/// assert!(chk.is_ok(),"{:?}",chk.err());
/// if chk.is_ok() {
/// let parsed = chk.unwrap();
/// match parsed {
/// Flql::DbNew(_) => {}
/// Flql::DbPerm(_) => {}
/// Flql::DbDrop(_) => {}
/// Flql::New(_) => {}
/// Flql::Drop(_) => {}
/// Flql::DropUser(_,_) => {}
/// Flql::Exists(_,_) => {}
/// Flql::Length(_) => {}
/// Flql::Flush(_) => {}
/// Flql::Ttl(_,_,_) => {}
/// Flql::Put(_, _) => {}
/// Flql::PutWhen(_, _, _) => {}
/// Flql::PutPointer(_, _, _) => {}
/// Flql::SearchTyping(_,_) => {}
/// Flql::Get(_,_,_) => {}
/// Flql::GetWhen(_, _,_,_) => {}
/// Flql::GetPointer(_, _) => {}
/// Flql::GetView(_, _) => {}
/// Flql::GetClip(_, _) => {}
/// Flql::GetIndex(_,_) => {}
/// Flql::GetRange(_,_,_,_) => {}
/// Flql::Delete(_) => {}
/// Flql::DeleteWhen(_, _) => {}
/// Flql::DeletePointer(_, _) => {}
/// Flql::DeleteClip(_, _) => {}
/// Flql::None => {}
/// }
/// }
/// }
/// ```
///
/// In `when` function you can use any expression from (https://github.com/tidwall/gjson.rs) to manipulate data.
///
/// Documentation is from gjson repo:
/// This document is designed to explain the structure of a GJSON Path through examples.
///
/// - [Path structure](#path-structure)
/// - [Basic](#basic)
/// - [Wildcards](#wildcards)
/// - [Escape Character](#escape-character)
/// - [Arrays](#arrays)
/// - [Queries](#queries)
/// - [Dot vs Pipe](#dot-vs-pipe)
/// - [Modifiers](#modifiers)
/// - [Multipaths](#multipaths)
/// - [Literals](#literals)
///
/// The definitive implemenation is [github.com/tidwall/gjson](https://github.com/tidwall/gjson).
/// Use the [GJSON Playground](https://gjson.dev) to experiment with the syntax online.
///
/// ## Path structure
///
/// A GJSON Path is intended to be easily expressed as a series of components seperated by a `.` character.
///
/// Along with `.` character, there are a few more that have special meaning, including `|`, `#`, `@`, `\`, `*`, `!`, and `?`.
///
/// ## Example
///
/// Given this JSON
///
/// ```json
/// {
/// "name": {"first": "Tom", "last": "Anderson"},
/// "age":37,
/// "children": ["Sara","Alex","Jack"],
/// "fav.movie": "Deer Hunter",
/// "friends": [
/// {"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]},
/// {"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]},
/// {"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]}
/// ]
/// }
/// ```
///
/// The following GJSON Paths evaluate to the accompanying values.
///
/// ### Basic
///
/// In many cases you'll just want to retreive values by object name or array index.
///
/// ```go
/// name.last "Anderson"
/// name.first "Tom"
/// age 37
/// children ["Sara","Alex","Jack"]
/// children.0 "Sara"
/// children.1 "Alex"
/// friends.1 {"first": "Roger", "last": "Craig", "age": 68}
/// friends.1.first "Roger"
/// ```
///
/// ### Wildcards
///
/// A key may contain the special wildcard characters `*` and `?`.
/// The `*` will match on any zero+ characters, and `?` matches on any one character.
///
/// ```go
/// child*.2 "Jack"
/// c?ildren.0 "Sara"
/// ```
///
/// ### Escape character
///
/// Special purpose characters, such as `.`, `*`, and `?` can be escaped with `\`.
///
/// ```go
/// fav\.movie "Deer Hunter"
/// ```
/// ### Arrays
///
/// The `#` character allows for digging into JSON Arrays.
///
/// To get the length of an array you'll just use the `#` all by itself.
///
/// ```go
/// friends.# 3
/// friends.#.age [44,68,47]
/// ```
///
/// ### Queries
///
/// You can also query an array for the first match by using `#(...)`, or find all matches with `#(...)#`.
/// Queries support the `==`, `!=`, `<`, `<=`, `>`, `>=` comparison operators,
/// and the simple pattern matching `%` (like) and `!%` (not like) operators.
///
/// ```go
/// friends.#(last=="Murphy").first "Dale"
/// friends.#(last=="Murphy")#.first ["Dale","Jane"]
/// friends.#(age>45)#.last ["Craig","Murphy"]
/// friends.#(first%"D*").last "Murphy"
/// friends.#(first!%"D*").last "Craig"
/// ```
///
/// To query for a non-object value in an array, you can forgo the string to the right of the operator.
///
/// ```go
/// children.#(!%"*a*") "Alex"
/// children.#(%"*a*")# ["Sara","Jack"]
/// ```
///
/// Nested queries are allowed.
///
/// ```go
/// friends.#(nets.#(=="fb"))#.first >> ["Dale","Roger"]
/// ```
///
/// *Please note that prior to v1.3.0, queries used the `#[...]` brackets. This was
/// changed in v1.3.0 as to avoid confusion with the new [multipath](#multipaths)
/// syntax. For backwards compatibility, `#[...]` will continue to work until the
/// next major release.*
///
/// The `~` (tilde) operator will convert a value to a boolean before comparison.
///
/// For example, using the following JSON:
///
/// ```json
/// {
/// "vals": [
/// { "a": 1, "b": true },
/// { "a": 2, "b": true },
/// { "a": 3, "b": false },
/// { "a": 4, "b": "0" },
/// { "a": 5, "b": 0 },
/// { "a": 6, "b": "1" },
/// { "a": 7, "b": 1 },
/// { "a": 8, "b": "true" },
/// { "a": 9, "b": false },
/// { "a": 10, "b": null },
/// { "a": 11 }
/// ]
/// }
/// ```
///
/// You can now query for all true(ish) or false(ish) values:
///
/// ```flql
/// vals.#(b==~true)#.a >> [1,2,6,7,8]
/// vals.#(b==~false)#.a >> [3,4,5,9,10,11]
/// ```
///
/// The last value which was non-existent is treated as `false`
///
/// ### Dot vs Pipe
///
/// The `.` is standard separator, but it's also possible to use a `|`.
/// In most cases they both end up returning the same results.
/// The cases where`|` differs from `.` is when it's used after the `#` for [Arrays](#arrays) and [Queries](#queries).
///
/// Here are some examples
///
/// ```go
/// friends.0.first "Dale"
/// friends|0.first "Dale"
/// friends.0|first "Dale"
/// friends|0|first "Dale"
/// friends|# 3
/// friends.# 3
/// friends.#(last="Murphy")# [{"first": "Dale", "last": "Murphy", "age": 44},{"first": "Jane", "last": "Murphy", "age": 47}]
/// friends.#(last="Murphy")#.first ["Dale","Jane"]
/// friends.#(last="Murphy")#|first <non-existent>
/// friends.#(last="Murphy")#.0 []
/// friends.#(last="Murphy")#|0 {"first": "Dale", "last": "Murphy", "age": 44}
/// friends.#(last="Murphy")#.# []
/// friends.#(last="Murphy")#|# 2
/// ```
///
/// Let's break down a few of these.
///
/// The path `friends.#(last="Murphy")#` all by itself results in
///
/// ```json
/// [{"first": "Dale", "last": "Murphy", "age": 44},{"first": "Jane", "last": "Murphy", "age": 47}]
/// ```
///
/// The `.first` suffix will process the `first` path on each array element *before* returning the results. Which becomes
///
/// ```json
/// ["Dale","Jane"]
/// ```
///
/// But the `|first` suffix actually processes the `first` path *after* the previous result.
/// Since the previous result is an array, not an object, it's not possible to process
/// because `first` does not exist.
///
/// Yet, `|0` suffix returns
///
/// ```json
/// {"first": "Dale", "last": "Murphy", "age": 44}
/// ```
///
/// Because `0` is the first index of the previous result.
///
/// ### Modifiers
///
/// A modifier is a path component that performs custom processing on the JSON.
///
/// For example, using the built-in `@reverse` modifier on the above JSON payload will reverse the `children` array:
///
/// ```go
/// children.@reverse ["Jack","Alex","Sara"]
/// children.@reverse.0 "Jack"
/// ```
///
/// There are currently the following built-in modifiers:
///
/// - `@reverse`: Reverse an array or the members of an object.
/// - `@ugly`: Remove all whitespace from JSON.
/// - `@pretty`: Make the JSON more human readable.
/// - `@this`: Returns the current element. It can be used to retrieve the root element.
/// - `@valid`: Ensure the json document is valid.
/// - `@flatten`: Flattens an array.
/// - `@join`: Joins multiple objects into a single object.
/// - `@keys`: Returns an array of keys for an object.
/// - `@values`: Returns an array of values for an object.
/// - `@tostr`: Converts json to a string. Wraps a json string.
/// - `@fromstr`: Converts a string from json. Unwraps a json string.
/// - `@group`: Groups arrays of objects. See [e4fc67c](https://github.com/tidwall/gjson/commit/e4fc67c92aeebf2089fabc7872f010e340d105db).
///
/// #### Modifier arguments
///
/// A modifier may accept an optional argument. The argument can be a valid JSON payload or just characters.
///
/// For example, the `@pretty` modifier takes a json object as its argument.
///
/// ```flql
/// @pretty:{"sortKeys":true}
/// ```
///
/// Which makes the json pretty and orders all of its keys.
///
/// ```json
/// {
/// "age":37,
/// "children": ["Sara","Alex","Jack"],
/// "fav.movie": "Deer Hunter",
/// "friends": [
/// {"age": 44, "first": "Dale", "last": "Murphy"},
/// {"age": 68, "first": "Roger", "last": "Craig"},
/// {"age": 47, "first": "Jane", "last": "Murphy"}
/// ],
/// "name": {"first": "Tom", "last": "Anderson"}
/// }
/// ```
///
/// *The full list of `@pretty` options are `sortKeys`, `indent`, `prefix`, and `width`.
/// Please see [Pretty Options](https://github.com/tidwall/pretty#customized-output) for more information.*
///
/// #### Custom modifiers
///
/// You can also add custom modifiers.
///
/// For example, here we create a modifier which makes the entire JSON payload upper or lower case.
///
/// ```go
/// gjson.AddModifier("case", func(json, arg string) string {
/// if arg == "upper" {
/// return strings.ToUpper(json)
/// }
/// if arg == "lower" {
/// return strings.ToLower(json)
/// }
/// return json
/// })
/// "children.@case:upper" ["SARA","ALEX","JACK"]
/// "children.@case:lower.@reverse" ["jack","alex","sara"]
/// ```
///
/// *Note: Custom modifiers are not yet available in the Rust version*
///
/// ### Multipaths
///
/// Starting with v1.3.0, GJSON added the ability to join multiple paths together
/// to form new documents. Wrapping comma-separated paths between `[...]` or
/// `{...}` will result in a new array or object, respectively.
///
/// For example, using the given multipath:
///
/// ```flql
/// {name.first,age,"the_murphys":friends.#(last="Murphy")#.first}
/// ```
///
/// Here we selected the first name, age, and the first name for friends with the
/// last name "Murphy".
///
/// You'll notice that an optional key can be provided, in this case
/// "the_murphys", to force assign a key to a value. Otherwise, the name of the
/// actual field will be used, in this case "first". If a name cannot be
/// determined, then "_" is used.
///
/// This results in
///
/// ```flql
/// {"first":"Tom","age":37,"the_murphys":["Dale","Jane"]}
/// ```
///
/// ### Literals
///
/// Starting with v1.12.0, GJSON added support of json literals, which provides a way for constructing static blocks of json. This is can be particularly useful when constructing a new json document using [multipaths](#multipaths).
///
/// A json literal begins with the '!' declaration character.
///
/// For example, using the given multipath:
///
/// ```json
/// {name.first,age,"company":!"Happysoft","employed":!true}
/// ```
///
/// Here we selected the first name and age. Then add two new fields, "company" and "employed".
///
/// This results in
///
/// ```json
/// {"first":"Tom","age":37,"company":"Happysoft","employed":true}
/// ```
;