Clippy lints / Restriction
Clippy lint · Restriction · checked with Clippy 0.1.99
clippy::dbg_macro: Checks for usage of the dbg! macro
What it meansChecks for usage of the dbg! macro. It is in the restriction group and off by default.
Does it matter?
The dbg! macro is intended as a debugging tool. It should not be present in released software or committed to a version control system.
Lints that forbid language features for specific codebases (no unwrap, no indexing...). Off by default; pick them one by one, never the whole group.
How to fix it
Clippy can fix this one for you: run cargo clippy --fix (add --allow-dirty if you have uncommitted changes). Review the diff before you commit.
Flagged
dbg!(true)
Write this instead
true
Turn it off, or on
It is off by default. To use it, set it to warn or deny:
Whole crate (Cargo.toml)
[lints.clippy]
dbg_macro = "warn"In code
#![warn(clippy::dbg_macro)]One run
cargo clippy -- -W clippy::dbg-macroThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Settings in clippy.toml
allow-dbg-in-tests: Whether dbg! should be allowed in test functions or #[cfg(test)]
Clippy's own documentation
What it does
Checks for usage of the dbg! macro.
Why restrict this?
The dbg! macro is intended as a debugging tool. It should not be present in released
software or committed to a version control system.
Example
dbg!(true)
Use instead:
true
Configuration
-
allow-dbg-in-tests: Whetherdbg!should be allowed in test functions or#[cfg(test)](default:
false)
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on Options
- module_name_repetitionsDetects public item names that are prefixed or suffixed by the containing public module’s name
- expect_usedChecks for .expect() or .expect_err() calls on Results and .expect() call on Options
- clone_on_ref_ptrChecks for usage of .clone() on a ref-counted pointer, (Rc, Arc, rc::Weak, or sync::Weak), and suggests calling Clone via unified function syntax instead (e.g., Rc::clone(foo))
- cognitive_complexityWe used to think it measured how hard a method is to understand
- create_dircalling `std::fs::create_dir` where there may be a better way
- decimal_literal_representationWarns if there is a better representation for a numeric literal
- default_numeric_fallbackdefault numeric fallback might occur
- default_union_representationthis union has the default representation
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on OptionsRead it next →Did this answer your question?