1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
use crate::{
builders::{self, DebugList, DebugMap, DebugNamedList, DebugSet, DebugStruct, DebugTuple},
Formatter,
};
impl Formatter {
/// Creates a [`DebugStruct`] builder designed to assist with creation of
/// [`crate::Debug`] implementations for structs.
///
/// # Examples
///
/// ```rust
/// use debug3::{pprint, Debug, Formatter};
/// use std::net::Ipv4Addr;
///
/// struct Foo {
/// bar: i32,
/// baz: String,
/// addr: Ipv4Addr,
/// }
///
/// impl Debug for Foo {
/// fn fmt(&self, fmt: &mut Formatter) {
/// fmt.debug_struct("Foo")
/// .field("bar", &self.bar)
/// .field("baz", &self.baz)
/// .field("addr", &format_args!("{}", self.addr))
/// .finish()
/// }
/// }
///
/// assert_eq!(
/// "\
/// Foo {
/// bar: 10,
/// baz: \"Hello World\",
/// addr: 127.0.0.1,
/// }",
/// pprint(Foo {
/// bar: 10,
/// baz: "Hello World".to_string(),
/// addr: Ipv4Addr::new(127, 0, 0, 1),
/// })
/// );
/// ```
pub fn debug_struct<'b>(&'b mut self, name: &str) -> DebugStruct<'b> {
builders::strukt::new(self, name)
}
/// Creates a `DebugTuple` builder designed to assist with creation of
/// `fmt::Debug` implementations for tuple structs.
///
/// # Examples
///
/// ```rust
/// use debug3::{pprint, Debug, Formatter};
/// use std::marker::PhantomData;
///
/// struct Foo<T>(i32, String, PhantomData<T>);
///
/// impl<T> Debug for Foo<T> {
/// fn fmt(&self, fmt: &mut Formatter) {
/// fmt.debug_tuple("Foo")
/// .field(&self.0)
/// .field(&self.1)
/// .field(&format_args!("_"))
/// .finish()
/// }
/// }
///
/// assert_eq!(
/// "Foo(10, \"Hello\", _)",
/// pprint(Foo(10, "Hello".to_string(), PhantomData::<u8>))
/// );
/// ```
pub fn debug_tuple<'b>(&'b mut self, name: &str) -> DebugTuple<'b> {
builders::tuple::new(self, name)
}
/// Creates a `DebugList` builder designed to assist with creation of
/// `fmt::Debug` implementations for list-like structures.
///
/// # Examples
///
/// ```rust
/// use debug3::{pprint, Debug, Formatter};
///
/// struct Foo(Vec<i32>);
///
/// impl Debug for Foo {
/// fn fmt(&self, fmt: &mut Formatter) {
/// fmt.debug_list().entries(self.0.iter()).finish()
/// }
/// }
///
/// assert_eq!(pprint(Foo(vec![10, 11])), "[10, 11]");
/// ```
pub fn debug_list(&mut self) -> DebugList<'_> {
builders::list::new(self)
}
/// Creates a `DebugList` builder designed to assist with creation of
/// `fmt::Debug` implementations for list-like structures with names.
///
/// # Examples
///
/// ```rust
/// use debug3::{pprint, Debug, Formatter};
///
/// struct Foo(Vec<i32>);
///
/// impl Debug for Foo {
/// fn fmt(&self, fmt: &mut Formatter) {
/// fmt.debug_named_list("Foo").entries(self.0.iter()).finish()
/// }
/// }
///
/// assert_eq!(pprint(Foo(vec![10, 11])), "Foo [10, 11]");
/// ```
pub fn debug_named_list(&mut self, name: &str) -> DebugNamedList<'_> {
builders::named_list::new(self, name)
}
/// Creates a `DebugSet` builder designed to assist with creation of
/// `fmt::Debug` implementations for set-like structures.
///
/// # Examples
///
/// ```rust
/// use debug3::{pprint, Debug, Formatter};
///
/// struct Foo(Vec<i32>);
///
/// impl Debug for Foo {
/// fn fmt(&self, fmt: &mut Formatter) {
/// fmt.debug_set().entries(self.0.iter()).finish()
/// }
/// }
///
/// assert_eq!(pprint(Foo(vec![10, 11])), "{10, 11}");
/// ```
pub fn debug_set(&mut self) -> DebugSet<'_> {
builders::set::new(self)
}
/// Creates a `DebugMap` builder designed to assist with creation of
/// `fmt::Debug` implementations for map-like structures.
///
/// # Examples
///
/// ```rust
/// use debug3::{pprint, Debug, Formatter};
///
/// struct Foo(Vec<(String, i32)>);
///
/// impl Debug for Foo {
/// fn fmt(&self, fmt: &mut Formatter) {
/// fmt.debug_map()
/// .entries(self.0.iter().map(|&(ref k, ref v)| (k, v)))
/// .finish()
/// }
/// }
///
/// assert_eq!(
/// pprint(Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])),
/// r#"{"A": 10, "B": 11}"#
/// );
/// ```
pub fn debug_map(&mut self) -> DebugMap<'_> {
builders::map::new(self)
}
/// Escape hatch to allow direct writing of values throug their
/// [`std::fmt::Debug`] impl.
///
/// Avoid this method whenever possible. It is likely to mess up your day.
/// Try to use the builder methods instead.
///
/// ```rust
/// # use std::ops::Range;
/// # use debug3::{Debug, Formatter, pprint};
///
/// struct Expr {
/// kind: ExprKind,
/// span: Range<usize>,
/// }
///
/// #[derive(Debug)]
/// enum ExprKind {
/// BinOp {
/// lhs: Box<Expr>,
/// op: char,
/// rhs: Box<Expr>,
/// },
/// Int(i32),
/// }
///
/// impl Debug for Expr {
/// fn fmt(&self, f: &mut Formatter) {
/// Debug::fmt(&self.kind, f);
/// f.write_display(" @ ");
/// f.write_debug(&self.span);
/// }
/// }
///
/// // 1 + 3 + 4
/// let expr = Expr {
/// kind: ExprKind::BinOp {
/// lhs: Box::new(Expr {
/// kind: ExprKind::BinOp {
/// lhs: Box::new(Expr {
/// kind: ExprKind::Int(1),
/// span: 0..1,
/// }),
/// op: '+',
/// rhs: Box::new(Expr {
/// kind: ExprKind::Int(3),
/// span: 4..5,
/// }),
/// },
/// span: 0..5,
/// }),
/// op: '+',
/// rhs: Box::new(Expr {
/// kind: ExprKind::Int(4),
/// span: 8..9,
/// }),
/// },
/// span: 8..9,
/// };
///
/// assert_eq!(
/// pprint(expr),
/// r"BinOp {
/// lhs: BinOp {
/// lhs: Int(1) @ 0..1,
/// op: '+',
/// rhs: Int(3) @ 4..5,
/// } @ 0..5,
/// op: '+',
/// rhs: Int(4) @ 8..9,
/// } @ 8..9"
/// );
/// ```
pub fn write_debug<T: std::fmt::Debug>(&mut self, val: T) {
let s = format!("{:?}", val);
self.word(s);
}
/// Escape hatch to allow direct writing of values throug their
/// [`std::fmt::Debug`] impl.
///
/// Avoid this method whenever possible. It is likely to mess up your day.
/// Try to use the builder methods instead.
///
/// See also [`Formatter::write_debug`]
pub fn write_display<T: std::fmt::Display>(&mut self, val: T) {
let s = format!("{}", val);
self.word(s);
}
}