Class DumpIsUsed

An optional detector that highlights all the dump function calls.

Why is it bad?

The dump function is a debug print that shouldn't be in the final code. Even though the compiler removes it in production, its presence suggests the developer was debugging something. This can flag areas where issues might exist, so auditors should take a closer look at these parts of the code.

Example

fun test(): Int {
  // ... other computations
  let combined: Int = (RANDOM_SEED >> half_shift) &
                      (MAGIC_CONSTANT << DIVIDE_BY_TWO) ^ shift_mask;
  dump(combined); // Suspicious: Highlighted by the detector
}

Use instead:

fun test(): Int {
  // ... other computations
  let combined: Int = this.seed ^ shift_mask
  // OK: The code was reviewed and simplified; `dump` was removed
}

Hierarchy (view full)

Constructors

constructor

Properties

ctx

Accessors

id kind shareImportedWarnings usesSouffle

Methods

check makeWarning skipUnused

Constructors

constructor

Properties

Readonlyctx

ctx: MistiContext

Accessors

id

  • get id(): string

  • Gets the short identifier of the detector, used in analyzer warnings.

    Returns string

    The unique identifier of the detector.

kind

shareImportedWarnings

  • get shareImportedWarnings(): WarningsBehavior

  • Defines the behavior of warnings generated by this detector when working with multiple projects within a single Tact configuration.

    Here are the available options:

    1. "union" Leave this value if you don't care about warnings generated in other projects.
    2. "intersect" If the warning is generated for some source location of the imported file, it should be generated by each of the projects. Example: Constants from an imported file should not be reported iff they are unused in all the projects, so you need "intersect".

    Returns WarningsBehavior

usesSouffle

  • get usesSouffle(): boolean

  • Checks whether this detector needs the Soufflé binary to be executed.

    Returns boolean

Methods

check

ProtectedmakeWarning

ProtectedskipUnused

  • skipUnused(name): boolean

  • Returns true if the identifier with the given name should not be reported by unused variables detectors.

    Parameters

    • name: string

    Returns boolean

Settings

Member Visibility

On This Page

Why is it bad?Example
Constructors
Properties
Accessors
Methods