Skip to content

Commit f0dce76

Browse files
Rollup merge of rust-lang#123940 - kornelski:remove-derived-debug, r=Urgau
debug-fmt-detail option I'd like to propose a new option that makes `#[derive(Debug)]` generate no-op implementations that don't print anything, and makes `{:?}` in format strings a no-op. There are a couple of motivations for this: 1. A more thorough stripping of debug symbols. Binaries stripped of debug symbols still retain some of them through `Debug` implementations. It's hard to avoid that without compiler's help, because debug formatting can be used in many places, including dependencies, and their loggers, asserts, panics, etc. * In my testing it gives about 2% binary size reduction on top of all other binary-minimizing best practices (including `panic_immediate_abort`). There are targets like Web WASM or embedded where users pay attention to binary sizes. * Users distributing closed-source binaries may not want to "leak" any symbol names as a matter of principle. 2. Adds ability to test whether code depends on specifics of the `Debug` format implementation in unwise ways (e.g. trying to get data unavailable via public interface, or using it as a serialization format). Because current Rust's debug implementation doesn't change, there's a risk of it becoming a fragile de-facto API that [won't be possible to change in the future](https://www.hyrumslaw.com/). An option that "breaks" it can act as a [grease](https://www.rfc-editor.org/rfc/rfc8701.html). This implementation is a `-Z fmt-debug=opt` flag that takes: * `full` — the default, current state. * `none` — makes derived `Debug` and `{:?}` no-ops. Explicit `impl Debug for T` implementations are left unharmed, but `{:?}` format won't use them, so they may get dead-code eliminated if they aren't invoked directly. * `shallow` — makes derived `Debug` print only the type's name, without recursing into fields. Fieldless enums print their variant names. `{:?}` works. The `shallow` option is a compromise between minimizing the `Debug` code, and compatibility. There are popular proc-macro crates that use `Debug::fmt` as a way to convert enum values into their Rust source code. There's a corresponding `cfg` flag: `#[cfg(fmt_debug = "none")]` that can be used in user code to react to this setting to minimize custom `Debug` implementations or remove unnecessary formatting helper functions.
2 parents 7c1560f + 86c924f commit f0dce76

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Diff for: core/src/fmt/rt.rs

+4
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ impl<'a> Argument<'a> {
118118
Self::new(x, Debug::fmt)
119119
}
120120
#[inline(always)]
121+
pub fn new_debug_noop<'b, T: Debug>(x: &'b T) -> Argument<'_> {
122+
Self::new(x, |_, _| Ok(()))
123+
}
124+
#[inline(always)]
121125
pub fn new_octal<'b, T: Octal>(x: &'b T) -> Argument<'_> {
122126
Self::new(x, Octal::fmt)
123127
}

0 commit comments

Comments
 (0)