|
1 | 1 | =====CONTENT===== |
| 2 | + |
2 | 3 | .. guideline:: Recursive function are not allowed |
3 | | - :id: gui_llfYnmAucaJQ |
4 | | - :category: required |
5 | | - :status: draft |
6 | | - :release: 1.3.0-latest |
7 | | - :fls: fls_vjgkg8kfi93 |
8 | | - :decidability: undecidable |
9 | | - :scope: system |
10 | | - :tags: increase-human-error |
11 | | - |
12 | | - Any function shall not call itself directly or indirectly |
13 | | - |
14 | | - .. rationale:: |
15 | | - :id: rat_bbk57IUR7pjD |
16 | | - :status: draft |
17 | | - |
18 | | - Recursive functions can easily cause stack overflows, which may result in exceptions or, in some cases, undefined behavior (typically some embedded systems). Although the Rust compiler supports [tail call optimization](https://en.wikipedia.org/wiki/Tail_call), this optimization is not guaranteed and depends on the specific implementation and function structure. There is an [open RFC to guarantee tail call optimization in the Rust compiler](https://github.com/phi-go/rfcs/blob/guaranteed-tco/text/0000-explicit-tail-calls.md), but this feature has not yet been stabilized. Until tail call optimization is guaranteed and stabilized, developers should avoid using recursive functions to prevent potential stack overflows and ensure program reliability. |
19 | | - |
20 | | - .. non_compliant_example:: |
21 | | - :id: non_compl_ex_bEG9g2wgnCci |
22 | | - :status: draft |
23 | | - |
24 | | - The below function `concat_strings` is not complaint because it call itself and depending on depth of data provided as input it could generate an stack overflow exception or undefine behavior. |
25 | | - THIS LINE WAS ADDED IN PURPOSE TO TEST SNAPSHOT TESTING??? |
26 | | - |
27 | | - .. code-block:: rust |
28 | | - |
29 | | - // Recursive enum to represent a string or a list of `MyEnum` |
30 | | - enum MyEnum { |
31 | | - Str(String), |
32 | | - List(Vec<MyEnum>), |
33 | | - } |
34 | | - |
35 | | - // Concatenates strings from a nested structure of `MyEnum` using recursion. |
36 | | - fn concat_strings(input: &[MyEnum]) -> String { |
37 | | - let mut result = String::new(); |
38 | | - for item in input { |
39 | | - match item { |
40 | | - MyEnum::Str(s) => result.push_str(s), |
41 | | - MyEnum::List(list) => result.push_str(&concat_strings(list)), |
42 | | - } |
43 | | - } |
44 | | - result |
45 | | - } |
46 | | - |
47 | | - .. compliant_example:: |
48 | | - :id: compl_ex_j9sv9nZWk1Eo |
49 | | - :status: draft |
50 | | - |
51 | | - The following code implements the same functionality using iteration instead of recursion. The `stack` variable is used to maintain the processing context at each step of the loop. This approach provides explicit control over memory usage. If the stack grows beyond a predefined limit due to the structure or size of the input, the function returns an error rather than risking a stack overflow or out-of-memory exception. This ensures more predictable and robust behavior in resource-constrained environments. |
52 | | - |
53 | | - .. code-block:: rust |
54 | | - |
55 | | - // Recursive enum to represent a string or a list of `MyEnum` |
56 | | - enum MyEnum { |
57 | | - Str(String), |
58 | | - List(Vec<MyEnum>), |
59 | | - } |
60 | | - |
61 | | - /// Concatenates strings from a nested structure of `MyEnum` without using recursion. |
62 | | - /// Returns an error if the stack size exceeds `MAX_STACK_SIZE`. |
63 | | - fn concat_strings_non_recursive(input: &[MyEnum]) -> Result<String, &'static str> { |
64 | | - const MAX_STACK_SIZE: usize = 1000; |
65 | | - let mut result = String::new(); |
66 | | - let mut stack = Vec::new(); |
67 | | - |
68 | | - // Add all items to the stack |
69 | | - stack.extend(input.iter()); |
70 | | - |
71 | | - while let Some(item) = stack.pop() { |
72 | | - match item { |
73 | | - MyEnum::Str(s) => result.insert_str(0, s), |
74 | | - MyEnum::List(list) => { |
75 | | - // Add list items to the stack |
76 | | - for sub_item in list.iter() { |
77 | | - stack.push(sub_item); |
78 | | - if stack.len() > MAX_STACK_SIZE { |
79 | | - return Err("Too big structure"); |
80 | | - } |
81 | | - } |
82 | | - } |
83 | | - } |
84 | | - } |
85 | | - Ok(result) |
86 | | - } |
| 4 | + :id: gui_1EDWRNKjs6It |
| 5 | + :category: required |
| 6 | + :status: draft |
| 7 | + :release: 1.3.0-latest |
| 8 | + :fls: fls_vjgkg8kfi93 |
| 9 | + :decidability: undecidable |
| 10 | + :scope: system |
| 11 | + :tags: reduce-human-error |
| 12 | + |
| 13 | + Any function shall not call itself directly or indirectly |
| 14 | + |
| 15 | + .. rationale:: |
| 16 | + :id: rat_Hbn0yLGzVdDK |
| 17 | + :status: draft |
| 18 | + |
| 19 | + Recursive functions can easily cause stack overflows, which may result in exceptions or, in some cases, undefined behavior (typically some embedded systems). Although the Rust compiler supports [tail call optimization](https://en.wikipedia.org/wiki/Tail_call), this optimization is not guaranteed and depends on the specific implementation and function structure. There is an [open RFC to guarantee tail call optimization in the Rust compiler](https://github.com/phi-go/rfcs/blob/guaranteed-tco/text/0000-explicit-tail-calls.md), but this feature has not yet been stabilized. Until tail call optimization is guaranteed and stabilized, developers should avoid using recursive functions to prevent potential stack overflows and ensure program reliability. |
| 20 | + |
| 21 | + .. non_compliant_example:: |
| 22 | + :id: non_compl_ex_eRmcumqqmMaZ |
| 23 | + :status: draft |
| 24 | + |
| 25 | + The below function `concat_strings` is not complaint because it call itself and depending on depth of data provided as input it could generate an stack overflow exception or undefine behavior. |
| 26 | + |
| 27 | + .. code-block:: rust |
| 28 | + |
| 29 | + // Recursive enum to represent a string or a list of `MyEnum` |
| 30 | + enum MyEnum { |
| 31 | + Str(String), |
| 32 | + List(Vec<MyEnum>), |
| 33 | + } |
| 34 | + |
| 35 | + // Concatenates strings from a nested structure of `MyEnum` using recursion. |
| 36 | + fn concat_strings(input: &[MyEnum]) -> String { |
| 37 | + let mut result = String::new(); |
| 38 | + for item in input { |
| 39 | + match item { |
| 40 | + MyEnum::Str(s) => result.push_str(s), |
| 41 | + MyEnum::List(list) => result.push_str(&concat_strings(list)), |
| 42 | + } |
| 43 | + } |
| 44 | + result |
| 45 | + } |
| 46 | + |
| 47 | + .. compliant_example:: |
| 48 | + :id: compl_ex_t6Hy8E2YlneV |
| 49 | + :status: draft |
| 50 | + |
| 51 | + The following code implements the same functionality using iteration instead of recursion. The `stack` variable is used to maintain the processing context at each step of the loop. This approach provides explicit control over memory usage. If the stack grows beyond a predefined limit due to the structure or size of the input, the function returns an error rather than risking a stack overflow or out-of-memory exception. This ensures more predictable and robust behavior in resource-constrained environments. |
| 52 | + |
| 53 | + .. code-block:: rust |
| 54 | + |
| 55 | + // Recursive enum to represent a string or a list of `MyEnum` |
| 56 | + enum MyEnum { |
| 57 | + Str(String), |
| 58 | + List(Vec<MyEnum>), |
| 59 | + } |
| 60 | + |
| 61 | + /// Concatenates strings from a nested structure of `MyEnum` without using recursion. |
| 62 | + /// Returns an error if the stack size exceeds `MAX_STACK_SIZE`. |
| 63 | + fn concat_strings_non_recursive(input: &[MyEnum]) -> Result<String, &'static str> { |
| 64 | + const MAX_STACK_SIZE: usize = 1000; |
| 65 | + let mut result = String::new(); |
| 66 | + let mut stack = Vec::new(); |
| 67 | + |
| 68 | + // Add all items to the stack |
| 69 | + stack.extend(input.iter()); |
| 70 | + |
| 71 | + while let Some(item) = stack.pop() { |
| 72 | + match item { |
| 73 | + MyEnum::Str(s) => result.insert_str(0, s), |
| 74 | + MyEnum::List(list) => { |
| 75 | + // Add list items to the stack |
| 76 | + for sub_item in list.iter() { |
| 77 | + stack.push(sub_item); |
| 78 | + if stack.len() > MAX_STACK_SIZE { |
| 79 | + return Err("Too big structure"); |
| 80 | + } |
| 81 | + } |
| 82 | + } |
| 83 | + } |
| 84 | + } |
| 85 | + Ok(result) |
| 86 | + } |
87 | 87 |
|
88 | 88 | =====CONTENT=END===== |
89 | | -Saved guideline to src/coding-guidelines/associated-items.rst |
0 commit comments