Debug
“Write to string” trait, for debug purposes.
Derivable: ✅
// Copyright 2025 Google LLC
// SPDX-License-Identifier: Apache-2.0
#[derive(Debug)]
pub struct Date {
day: u8,
month: u8,
year: i64,
}
#[derive(Debug)]
pub struct User {
name: String,
date_of_birth: Date,
}
pub struct PlainTextPassword {
password: String,
hint: String,
}
impl std::fmt::Debug for PlainTextPassword {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("PlainTextPassword")
.field("hint", &self.hint)
.field("password", &"[omitted]")
.finish()
}
}
fn main() {
let user = User {
name: "Alice".to_string(),
date_of_birth: Date { day: 31, month: 10, year: 2002 },
};
println!("{user:?}");
println!(
"{:?}",
PlainTextPassword {
password: "Password123".to_string(),
hint: "Used it for years".to_string()
}
);
}
-
Provides trivial “write to string” functionality.
-
Formatting for debug information for programmers during development, not appearance or serialization.
-
Allows for use of
{:?}and{#?}interpolation in string formatting macros. -
When to not derive/implement: If a struct holds sensitive data, investigate if you should implement
Debugfor it.- If
Debugis needed, consider manually implementingDebugrather than deriving it. Omit the sensitive data from the implementation.
- If