Struct std::fmt::DebugList

#[must_use = "must eventually call `finish()` on Debug builders"]
pub struct DebugList<'a, 'b> where
    'b: 'a,  { /* fields omitted */ }

一个有助于 fmt::Debug 实现的结构体。

当您希望输出格式化的项列表作为 Debug::fmt 实现的一部分时，此功能很有用。

这可以通过 Formatter::debug_list 方法创建。

Examples

use std::fmt;

struct Foo(Vec<i32>);

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.debug_list().entries(self.0.iter()).finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![10, 11])),
    "[10, 11]",
);

Implementations

impl<'a, 'b> DebugList<'a, 'b> where
    'b: 'a, 

pub fn entry(&mut self, entry: &dyn Debug) -> &mut DebugList<'a, 'b>

将新条目添加到列表输出中。

Examples

use std::fmt;

struct Foo(Vec<i32>, Vec<u32>);

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_list()
           .entry(&self.0) // 我们添加第一个 "entry"。
           .entry(&self.1) // 我们添加第二个 "entry"。
           .finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![10, 11], vec![12, 13])),
    "[[10, 11], [12, 13]]",
);

pub fn entries<D, I>(&mut self, entries: I) -> &mut DebugList<'a, 'b> where
    I: IntoIterator<Item = D>,
    D: Debug, 

将条目迭代器的内容添加到列表输出中。

Examples

use std::fmt;

struct Foo(Vec<i32>, Vec<u32>);

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_list()
           .entries(self.0.iter())
           .entries(self.1.iter())
           .finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![10, 11], vec![12, 13])),
    "[10, 11, 12, 13]",
);

pub fn finish(&mut self) -> Result<(), Error>

完成输出并返回遇到的任何错误。

Examples

use std::fmt;

struct Foo(Vec<i32>);

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_list()
           .entries(self.0.iter())
           .finish() // 结束结构体格式化。
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![10, 11])),
    "[10, 11]",
);