diff options
| author | Trevor Gross <tmgross@umich.edu> | 2024-11-21 03:46:59 -0500 | 
|---|---|---|
| committer | Trevor Gross <tmgross@umich.edu> | 2024-11-22 19:46:34 -0500 | 
| commit | c1707aaf0b8da047db0c1e1d97c7fa6c3545672d (patch) | |
| tree | aab1ce855cb3c7095a7cd208159ec30057d0eafa | |
| parent | 318f96a8cf3eca5c4aaf60a992f349bce5c3fd41 (diff) | |
| download | rust-c1707aaf0b8da047db0c1e1d97c7fa6c3545672d.tar.gz rust-c1707aaf0b8da047db0c1e1d97c7fa6c3545672d.zip  | |
Shorten the `MaybeUninit` `Debug` implementation
Currently the `Debug` implementation for `MaybeUninit` winds up being
pretty verbose. This struct:
    #[derive(Debug)]
    pub struct Foo {
        pub a: u32,
        pub b: &'static str,
        pub c: MaybeUninit<u32>,
        pub d: MaybeUninit<String>,
    }
Prints as:
    Foo {
        a: 0,
        b: "hello",
        c: core::mem::maybe_uninit::MaybeUninit<u32>,
        d: core::mem::maybe_uninit::MaybeUninit<alloc::string::String>,
    }
The goal is just to be a standin for content so the path prefix doesn't
add any useful information. Change the implementation to trim
`MaybeUninit`'s leading path, meaning the new result is now:
    Foo {
        a: 0,
        b: "hello",
        c: MaybeUninit<u32>,
        d: MaybeUninit<alloc::string::String>,
    }
| -rw-r--r-- | library/core/src/mem/maybe_uninit.rs | 6 | ||||
| -rw-r--r-- | library/core/tests/fmt/mod.rs | 7 | 
2 files changed, 12 insertions, 1 deletions
diff --git a/library/core/src/mem/maybe_uninit.rs b/library/core/src/mem/maybe_uninit.rs index 58315cb74f0..27273e4eedf 100644 --- a/library/core/src/mem/maybe_uninit.rs +++ b/library/core/src/mem/maybe_uninit.rs @@ -255,7 +255,11 @@ impl<T: Copy> Clone for MaybeUninit<T> { #[stable(feature = "maybe_uninit_debug", since = "1.41.0")] impl<T> fmt::Debug for MaybeUninit<T> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.pad(type_name::<Self>()) + // NB: there is no `.pad_fmt` so we can't use a simpler `format_args!("MaybeUninit<{..}>"). + // This needs to be adjusted if `MaybeUninit` moves modules. + let full_name = type_name::<Self>(); + let short_name = full_name.split_once("mem::maybe_uninit::").unwrap().1; + f.pad(short_name) } } diff --git a/library/core/tests/fmt/mod.rs b/library/core/tests/fmt/mod.rs index 704d2461399..f7512abae38 100644 --- a/library/core/tests/fmt/mod.rs +++ b/library/core/tests/fmt/mod.rs @@ -43,3 +43,10 @@ fn pad_integral_resets() { assert_eq!(format!("{Bar:<03}"), "1 0051 "); } + +#[test] +fn test_maybe_uninit_short() { + // Ensure that the trimmed `MaybeUninit` Debug implementation doesn't break + let x = core::mem::MaybeUninit::new(0u32); + assert_eq!(format!("{x:?}"), "MaybeUninit<u32>"); +}  | 
