diff --git a/rules/S7426/metadata.json b/rules/S7426/metadata.json new file mode 100644 index 0000000000..2c63c08510 --- /dev/null +++ b/rules/S7426/metadata.json @@ -0,0 +1,2 @@ +{ +} diff --git a/rules/S7426/rust/metadata.json b/rules/S7426/rust/metadata.json new file mode 100644 index 0000000000..093f96132e --- /dev/null +++ b/rules/S7426/rust/metadata.json @@ -0,0 +1,24 @@ +{ + "title": "C-like enums should not have unportable variants", + "type": "BUG", + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "5min" + }, + "tags": [ + "clippy" + ], + "defaultSeverity": "Critical", + "ruleSpecification": "RSPEC-7426", + "sqKey": "S7426", + "scope": "All", + "defaultQualityProfiles": ["Sonar way"], + "quickfix": "unknown", + "code": { + "impacts": { + "RELIABILITY": "HIGH" + }, + "attribute": "LOGICAL" + } +} diff --git a/rules/S7426/rust/rule.adoc b/rules/S7426/rust/rule.adoc new file mode 100644 index 0000000000..87bba8bdcb --- /dev/null +++ b/rules/S7426/rust/rule.adoc @@ -0,0 +1,32 @@ + +== Why is this an issue? +Using `repr(isize/usize)` for C-like enumerations with values that don't fit into an `i32` can lead to truncated variant values on 32-bit architectures, potentially causing unexpected behavior. + + +=== Code examples + +==== Noncompliant code example +[source,rust,diff-id=1,diff-type=noncompliant] +---- +#[repr(usize)] +enum NonPortable { + X = 0x1_0000_0000, // Noncompliant + Y = 0, +} +---- + +==== Compliant solution + +[source,rust,diff-id=1,diff-type=compliant] +---- +#[repr(u64)] +enum Portable { + X = 0x1_0000_0000, // Compliant + Y = 0, +} +---- + +== Resources +=== Documentation + +* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#enum_clike_unportable_variant