Rust Classes Corresponding to Clippy Lints

• Introduction
• Rust Warning Classes from Clippy Lints
• Built-in Rust Warning Classes
• Enabling and Disabling

Introduction

This page describes the CodeSonar warning classes that are assigned to warnings imported from a SARIF file produced by Rust Clippy.

For information on setting up your CodeSonar project to incorporate Rust source code and the corresponding Clippy results, see Including Rust Components in a CodeSonar Project.

Rust Warning Classes from Clippy Lints

When CodeSonar imports a SARIF file, it determines a corresponding CodeSonar warning class for each rule object in the SARIF rules. If a given warning class does not already exist, the SARIF importer creates it.

There is special handling for SARIF files produced by Rust Clippy.

• CodeSonar ships with a large number of built-in Rust warning classes corresponding to messages from Clippy version rust-1.89.0. Each of these classes has the following properties.
  • The Name is generated using a Clippy-specific mechanism.
  • The Categories include a mnemonic (in the RUST.* branch of the CodeSonar mnemonic hierarchy) and a Clippy:<id> category.
• In cases where there is no existing warning class corresponding to a particular rule object in the SARIF rules, the SARIF importer creates a new warning class.
  • The Name is generated using the same Clippy-specific mechanism used for the built-in language warning classes.
  • The Categories include a Clippy:<id> category, but no mnemonic.

Clippy-specific handling for warning class names and categories

Example

Suppose the imported SARIF file includes a rule object like the following.

# ...
    "rules":[
        # ...
      {
          "id": "approx_constant",
          # SARIF produced by clippy-sarif does not include a "name"
        # ...
      },
      # ...
    ], 
# ...

(This corresponds to the Rust Clippy approx_constant lint.)

1. CodeSonar computes the corresponding warning class name: "Approx Constant (Rust Clippy)".
2. If there is not already a warning class with this name, CodeSonar creates the warning class.
   The new warning class will have one associated category: Clippy:approx_constant.
3. CodeSonar creates a "Approx Constant (Rust Clippy) " warning instance for each result entry in the SARIF that has "ruleID":"approx_constant".

SARIF files produced by Rust Clippy

CodeSonar will consider a SARIF file to be produced by Rust Clippy in the following cases.

• The SARIF file was produced and imported via a codesonar rust_scan.py invocation.
• The file is imported with a codesonar import_sarif.py invocation that specifies -analyzer clippy.
• The file is imported with a codesonar import_sarif.py invocation that does not specify -analyzer, and the SARIF importer can determine from the file contents that it was produced by Rust Clippy.

Built-in Rust Warning Classes

These warning classes correspond to lints from Rust Clippy version rust-1.89.0.

Enabling and Disabling

You have multiple degrees of control over reporting for the warnings issued by Rust Clippy.

• To enable or disable checking for a specific Rust Clippy lint (and thus the corresponding CodeSonar warning class), you will need to configure Clippy.
• To selectively disable submission to the hub for a warning or set of warnings, define a WARNING_FILTER discard rule in a suitable CodeSonar configuration file.

  You can also specify a combination of WARNING_FILTER discard and WARNING_FILTER allow rules, if that is the most convenient way to characterize a specific set. When you specify warning class names (or parts of names) in your WARNING_FILTER rules, make sure you are using the generated CodeSonar warning class name as described above.