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
use crate::{DebugPls, Formatter};

/// A helper designed to assist with creation of
/// [`DebugPls`] implementations for list-like structures.
///
/// # Examples
///
/// ```rust
/// use dbg_pls::{pretty, DebugPls, Formatter};
///
/// struct Foo(Vec<i32>);
///
/// impl DebugPls for Foo {
///     fn fmt(&self, f: Formatter<'_>) {
///         f.debug_list().entries(&self.0).finish()
///     }
/// }
///
/// let value = Foo(vec![10, 11]);
/// assert_eq!(format!("{}", pretty(&value)), "[10, 11]");
/// ```
pub struct DebugList<'a> {
    formatter: Formatter<'a>,
    expr: syn::ExprArray,
}

impl<'a> DebugList<'a> {
    pub(crate) fn new(formatter: Formatter<'a>) -> Self {
        DebugList {
            formatter,
            expr: syn::ExprArray {
                attrs: vec![],
                bracket_token: syn::token::Bracket::default(),
                elems: syn::punctuated::Punctuated::default(),
            },
        }
    }

    /// Adds a new entry to the list output.
    #[must_use]
    pub fn entry(mut self, entry: &dyn DebugPls) -> Self {
        self.expr.elems.push(Formatter::process(entry));
        self
    }

    /// Adds all the entries to the list output.
    #[must_use]
    pub fn entries<D, I>(mut self, entries: I) -> Self
    where
        D: DebugPls,
        I: IntoIterator<Item = D>,
    {
        self.extend(entries);
        self
    }

    /// Closes off the list
    pub fn finish(self) {
        self.formatter.write_expr(self.expr);
    }
}

impl<'f, D: DebugPls> Extend<D> for DebugList<'f> {
    fn extend<T: IntoIterator<Item = D>>(&mut self, iter: T) {
        self.expr
            .elems
            .extend(iter.into_iter().map(|entry| Formatter::process(&entry)));
    }
}