Email me

Clippy lints / Pedantic

Clippy lint · Pedantic · checked with Clippy 0.1.99

clippy::unnecessary_debug_formatting: Checks for Debug formatting ({:?}) applied to an OsStr or Path. This includes: Format specifiers on format_args!() (width, precision have no effect) Format width too small for the format trait (e.g

What it meansChecks for Debug formatting ({:?}) applied to an OsStr or Path. This includes: Format specifiers on format_args!() (width, precision have no effect) Format width too small for the format trait (e.g. {:#02x} outputs “0x1” so width 2 has no effect; minimum is 4 for alternate hex/octal/binary) It is in the pedantic group and off by default.

Does it matter?

Rust doesn’t guarantee what Debug formatting looks like, and it could change in the future. OsStrs and Paths can be Display formatted using their display methods. Furthermore, with Debug formatting, certain characters are escaped. Thus, a Debug formatted Path is less likely to be clickable.

Stricter lints with some false positives. Off by default; opt in with clippy::pedantic.

How to fix it

Clippy does not fix this one automatically. Change the code by hand:

Flagged

let path = Path::new("...");
println!("The path is {:?}", path);

Write this instead

let path = Path::new("…");
println!("The path is {}", path.display());

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]
unnecessary_debug_formatting = "warn"

In code

#![warn(clippy::unnecessary_debug_formatting)]

One run

cargo clippy -- -W clippy::unnecessary-debug-formatting

The [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.

Pedanticgroup
allowdefault level
nofixed by cargo clippy --fix
1.87.0added in Rust

Clippy's own documentation

What it does

Checks for Debug formatting ({:?}) applied to an OsStr or Path.

This includes:

  • Format specifiers on format_args!() (width, precision have no effect)
  • Format width too small for the format trait (e.g. {:#02x} outputs “0x1” so width 2 has no effect; minimum is 4 for alternate hex/octal/binary)

Why is this bad?

Rust doesn’t guarantee what Debug formatting looks like, and it could change in the future. OsStrs and Paths can be Display formatted using their display methods.

Furthermore, with Debug formatting, certain characters are escaped. Thus, a Debug formatted Path is less likely to be clickable.

Example

let path = Path::new("...");
println!("The path is {:?}", path);

Use instead:

let path = Path::new("…");
println!("The path is {}", path.display());

From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.

Related lints

All 847 Clippy lints · Rust compiler errors · Cargo.toml checker

Up next

Related lintclippy::too_many_linesChecks for functions with a large amount of linesRead it next →

Did this answer your question?

Get the receipts by email.

What my AI agents tried this week, with the real numbers: what worked, what flopped, what made money. One email when there is something worth reading.

No spam, never sold. Every email has a one-click unsubscribe.

Popular in the shop

All 124 tools →

Browse: Bundles and kitsHome, family and schoolMoney and businessAI toolsSports and fitnessMaking and hobbiesFood and drinkIndie dev and launchTrading and quant

Free: Landing page teardown iPhone app cost calculator LLM API cost calculator Paid online: $49 Launch Check App builds Articles FAQ