Skip to content

Commit 7ec8f5c

Browse files
borsbors
committed
Auto merge of #32054 - seanmonstar:impl-debug-core, r=alexcrichton
libcore: add Debug implementations to most missing types Also adds `#![deny(missing_debug_implementations)]` to the core crate. cc #31869
2 parents 6c4b1f1 + e094593 commit 7ec8f5c

File tree

17 files changed

+319
-34
lines changed

17 files changed

+319
-34
lines changed

‎src/libcore/char.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -416,14 +416,14 @@ pub fn encode_utf16_raw(mut ch: u32, dst: &mut [u16]) -> Option<usize> {
416416
///
417417
/// [`escape_unicode()`]: ../../std/primitive.char.html#method.escape_unicode
418418
/// [`char`]: ../../std/primitive.char.html
419-
#[derive(Clone)]
419+
#[derive(Clone, Debug)]
420420
#[stable(feature = "rust1", since = "1.0.0")]
421421
pub struct EscapeUnicode {
422422
c: char,
423423
state: EscapeUnicodeState
424424
}
425425

426-
#[derive(Clone)]
426+
#[derive(Clone, Debug)]
427427
enum EscapeUnicodeState {
428428
Backslash,
429429
Type,
@@ -496,13 +496,13 @@ impl Iterator for EscapeUnicode {
496496
///
497497
/// [`escape_default()`]: ../../std/primitive.char.html#method.escape_default
498498
/// [`char`]: ../../std/primitive.char.html
499-
#[derive(Clone)]
499+
#[derive(Clone, Debug)]
500500
#[stable(feature = "rust1", since = "1.0.0")]
501501
pub struct EscapeDefault {
502502
state: EscapeDefaultState
503503
}
504504

505-
#[derive(Clone)]
505+
#[derive(Clone, Debug)]
506506
enum EscapeDefaultState {
507507
Backslash(char),
508508
Char(char),

‎src/libcore/fmt/builders.rs

+5
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ impl<'a, 'b: 'a> fmt::Write for PadAdapter<'a, 'b> {
5454
///
5555
/// Constructed by the `Formatter::debug_struct` method.
5656
#[must_use]
57+
#[allow(missing_debug_implementations)]
5758
#[stable(feature = "debug_builders", since = "1.2.0")]
5859
pub struct DebugStruct<'a, 'b: 'a> {
5960
fmt: &'a mut fmt::Formatter<'b>,
@@ -120,6 +121,7 @@ impl<'a, 'b: 'a> DebugStruct<'a, 'b> {
120121
///
121122
/// Constructed by the `Formatter::debug_tuple` method.
122123
#[must_use]
124+
#[allow(missing_debug_implementations)]
123125
#[stable(feature = "debug_builders", since = "1.2.0")]
124126
pub struct DebugTuple<'a, 'b: 'a> {
125127
fmt: &'a mut fmt::Formatter<'b>,
@@ -231,6 +233,7 @@ impl<'a, 'b: 'a> DebugInner<'a, 'b> {
231233
///
232234
/// Constructed by the `Formatter::debug_set` method.
233235
#[must_use]
236+
#[allow(missing_debug_implementations)]
234237
#[stable(feature = "debug_builders", since = "1.2.0")]
235238
pub struct DebugSet<'a, 'b: 'a> {
236239
inner: DebugInner<'a, 'b>,
@@ -279,6 +282,7 @@ impl<'a, 'b: 'a> DebugSet<'a, 'b> {
279282
///
280283
/// Constructed by the `Formatter::debug_list` method.
281284
#[must_use]
285+
#[allow(missing_debug_implementations)]
282286
#[stable(feature = "debug_builders", since = "1.2.0")]
283287
pub struct DebugList<'a, 'b: 'a> {
284288
inner: DebugInner<'a, 'b>,
@@ -327,6 +331,7 @@ impl<'a, 'b: 'a> DebugList<'a, 'b> {
327331
///
328332
/// Constructed by the `Formatter::debug_map` method.
329333
#[must_use]
334+
#[allow(missing_debug_implementations)]
330335
#[stable(feature = "debug_builders", since = "1.2.0")]
331336
pub struct DebugMap<'a, 'b: 'a> {
332337
fmt: &'a mut fmt::Formatter<'b>,

‎src/libcore/fmt/mod.rs

+22-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
use prelude::v1::*;
1616

17-
use cell::{Cell, RefCell, Ref, RefMut, BorrowState};
17+
use cell::{UnsafeCell, Cell, RefCell, Ref, RefMut, BorrowState};
1818
use marker::PhantomData;
1919
use mem;
2020
use num::flt2dec;
@@ -25,6 +25,7 @@ use str;
2525

2626
#[unstable(feature = "fmt_flags_align", issue = "27726")]
2727
/// Possible alignments returned by `Formatter::align`
28+
#[derive(Debug)]
2829
pub enum Alignment {
2930
/// Indication that contents should be left-aligned.
3031
Left,
@@ -152,6 +153,7 @@ impl<'a, W: Write + ?Sized> Write for &'a mut W {
152153
/// A struct to represent both where to emit formatting strings to and how they
153154
/// should be formatted. A mutable version of this is passed to all formatting
154155
/// traits.
156+
#[allow(missing_debug_implementations)]
155157
#[stable(feature = "rust1", since = "1.0.0")]
156158
pub struct Formatter<'a> {
157159
flags: u32,
@@ -175,6 +177,7 @@ enum Void {}
175177
/// compile time it is ensured that the function and the value have the correct
176178
/// types, and then this struct is used to canonicalize arguments to one type.
177179
#[derive(Copy)]
180+
#[allow(missing_debug_implementations)]
178181
#[unstable(feature = "fmt_internals", reason = "internal to format_args!",
179182
issue = "0")]
180183
#[doc(hidden)]
@@ -1585,7 +1588,9 @@ impl<T: ?Sized> Debug for PhantomData<T> {
15851588
#[stable(feature = "rust1", since = "1.0.0")]
15861589
impl<T: Copy + Debug> Debug for Cell<T> {
15871590
fn fmt(&self, f: &mut Formatter) -> Result {
1588-
write!(f, "Cell {{ value: {:?} }}", self.get())
1591+
f.debug_struct("Cell")
1592+
.field("value", &self.get())
1593+
.finish()
15891594
}
15901595
}
15911596

@@ -1594,9 +1599,15 @@ impl<T: ?Sized + Debug> Debug for RefCell<T> {
15941599
fn fmt(&self, f: &mut Formatter) -> Result {
15951600
match self.borrow_state() {
15961601
BorrowState::Unused | BorrowState::Reading => {
1597-
write!(f, "RefCell {{ value: {:?} }}", self.borrow())
1602+
f.debug_struct("RefCell")
1603+
.field("value", &self.borrow())
1604+
.finish()
1605+
}
1606+
BorrowState::Writing => {
1607+
f.debug_struct("RefCell")
1608+
.field("value", &"<borrowed>")
1609+
.finish()
15981610
}
1599-
BorrowState::Writing => write!(f, "RefCell {{ <borrowed> }}"),
16001611
}
16011612
}
16021613
}
@@ -1615,5 +1626,12 @@ impl<'b, T: ?Sized + Debug> Debug for RefMut<'b, T> {
16151626
}
16161627
}
16171628

1629+
#[stable(feature = "core_impl_debug", since = "1.9.0")]
1630+
impl<T: ?Sized + Debug> Debug for UnsafeCell<T> {
1631+
fn fmt(&self, f: &mut Formatter) -> Result {
1632+
f.pad("UnsafeCell")
1633+
}
1634+
}
1635+
16181636
// If you expected tests to be here, look instead at the run-pass/ifmt.rs test,
16191637
// it's a lot easier than creating all of the rt::Piece structures here.

‎src/libcore/fmt/rt/v1.rs

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
//!
1414
//! These definitions are similar to their `ct` equivalents, but differ in that
1515
//! these can be statically allocated and are slightly optimized for the runtime
16+
#![allow(missing_debug_implementations)]
1617

1718
#[derive(Copy, Clone)]
1819
pub struct Argument {

‎src/libcore/hash/mod.rs

+8
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373

7474
use prelude::v1::*;
7575

76+
use fmt;
7677
use marker;
7778
use mem;
7879

@@ -215,6 +216,13 @@ pub trait BuildHasher {
215216
#[stable(since = "1.7.0", feature = "build_hasher")]
216217
pub struct BuildHasherDefault<H>(marker::PhantomData<H>);
217218

219+
#[stable(since = "1.9.0", feature = "core_impl_debug")]
220+
impl<H> fmt::Debug for BuildHasherDefault<H> {
221+
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
222+
f.pad("BuildHasherDefault")
223+
}
224+
}
225+
218226
#[stable(since = "1.7.0", feature = "build_hasher")]
219227
impl<H: Default + Hasher> BuildHasher for BuildHasherDefault<H> {
220228
type Hasher = H;

‎src/libcore/hash/sip.rs

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ use super::Hasher;
3030
/// Although the SipHash algorithm is considered to be generally strong,
3131
/// it is not intended for cryptographic purposes. As such, all
3232
/// cryptographic uses of this implementation are _strongly discouraged_.
33+
#[derive(Debug)]
3334
#[stable(feature = "rust1", since = "1.0.0")]
3435
pub struct SipHasher {
3536
k0: u64,

0 commit comments

Comments
 (0)