Rollup merge of #92322 - alper:add_debug_trait_documentation, r=dtolnay
Add another implementation example to Debug trait As per the discussion in: #92276
This commit is contained in:
commit
a0262fdf1f
@ -570,11 +570,30 @@ impl Display for Arguments<'_> {
|
||||
/// There are a number of helper methods on the [`Formatter`] struct to help you with manual
|
||||
/// implementations, such as [`debug_struct`].
|
||||
///
|
||||
/// [`debug_struct`]: Formatter::debug_struct
|
||||
///
|
||||
/// Types that do not wish to use the standard suite of debug representations
|
||||
/// provided by the `Formatter` trait (`debug_struct`, `debug_tuple`,
|
||||
/// `debut_list`, `debug_set`, `debug_map`) can do something totally custom by
|
||||
/// manually writing an arbitrary representation to the `Formatter`.
|
||||
///
|
||||
/// ```
|
||||
/// # use std::fmt;
|
||||
/// # struct Point {
|
||||
/// # x: i32,
|
||||
/// # y: i32,
|
||||
/// # }
|
||||
/// #
|
||||
/// impl fmt::Debug for Point {
|
||||
/// fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
/// write!(f, "Point [{} {}]", self.x, self.y)
|
||||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// `Debug` implementations using either `derive` or the debug builder API
|
||||
/// on [`Formatter`] support pretty-printing using the alternate flag: `{:#?}`.
|
||||
///
|
||||
/// [`debug_struct`]: Formatter::debug_struct
|
||||
///
|
||||
/// Pretty-printing with `#?`:
|
||||
///
|
||||
/// ```
|
||||
|
Loading…
x
Reference in New Issue
Block a user