string_mult 0.3.4

String multiplication commands parser and evaluator
Documentation 
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

# String Multiplication


- Link: https://crates.io/crates/string_mult
- Docs: https://docs.rs/string_mult/latest/string_mult/

The library provides a parser for simple commands that allow multiplying strings. The library supports commands for multiplying numbers in strings, duplicating strings, and multiplying all numbers in a string. The results of the parsing process are used to evaluate the commands and return their results. 

The library uses the `pest` parser generator to define the grammar of the commands. 

## Parsing Process


1. **Grammar Definition**: The grammar is defined in the `gramm.pest` file. It includes rules for:
   - `num`: Recognizes signed floating point or integer numbers.
   - `int`: Recognizes signed integer numbers.
   - `mult`: Recognizes multiplication operators with optional indices.
   - `multAll`: Recognizes multiplication operators for multiplying all numbers in a string.
   - `duplicate`: Recognizes duplication operators.
   - `inner_str_text`: Recognizes parts of the string parameters that are not numbers.
   - `str_param`: Recognizes string parameters surrounded by quote marks.
   - `command`: Recognizes complete commands for multiplying strings.
   - `commands_list`: Recognizes a list of commands.
   - `wrong_command`: Recognizes incorrect commands in commands list.

![parsing scheme illustraition](https://raw.githubusercontent.com/ArtemiiKolomiichuk/string_mult/refs/heads/master/scheme.png)

2. **Parsing**: The library includes `parse_command` and `parse_list` functions that parse string and return `StringMultCommand` and `Vec<StringMultCommand>` respectively.

3. **Evaluation**: The library includes `evaluate` and `evaluate_list` functions that parse string and string from file respectively and return the result of the command execution.

## Commands examples


1. Multiply first number in string by provided number
    - `"15 packs, 10mg/l" * 10` -> `150 packs, 10mg/l`
\
&nbsp;

2. Multiply n<sup>th</sup> number in string by provided number
    - `"15 packs, 10mg/l" *[0] 10` -> `150 packs, 10mg/l`
    - `"15 packs A, 10 packs B" *[1] 10` -> `15 packs A, 100 packs B`

    ###### Multiply n<sup>th</sup> from end number in string by provided number
    - `"15 packs A, 10 packs B, 9..." *[-1] 10` -> `15 packs A, 10 packs B, 90...`  
    - `"15 packs A, 10 packs B, 9..." *[-2] 10` -> `15 packs A, 100 packs B, 9...`
\
&nbsp;

3. Multiply all numbers in string by provided number
    - `"15 packs A, 10 packs B, 9..." ** 10` -> `150 packs A, 100 packs B, 90...`
\
&nbsp;

4. Duplicate a string n times
    - `"123" *** 3` -> `123123123`
    - `"123" *** 0` -> ` `
    ###### Duplicate reversed string n times 
    - `"123" *** -1` -> `321`
    - `"123" *** -2` -> `321321`  
\
&nbsp;

5. Evaluate commands list
    -  + `"12 packs " *** 3 *2`
       + `"4packs" *[2]2`
       + `"9 bottles." **3`
    - &darr;
    - + `24 packs 12 packs 12 packs `
      + `Error: index '2' out of range '0..1'`
      + `27 bottles`