Struct core::fmt::DebugMap

1.2.0 · source ·
pub struct DebugMap<'a, 'b: 'a> { /* private fields */ }
Expand description

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

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

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

Examples

use std::fmt;

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

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_map().entries(self.0.iter().map(|&(ref k, ref v)| (k, v))).finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])),
    "{\"A\": 10, \"B\": 11}",
);
Run

Implementations§

source§

impl<'a, 'b: 'a> DebugMap<'a, 'b>

source

pub fn entry(&mut self, key: &dyn Debug, value: &dyn Debug) -> &mut Self

在 map 输出中添加一个新条目。

Examples
use std::fmt;

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

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_map()
           .entry(&"whole", &self.0) // 我们添加 "whole" 条目。
           .finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])),
    "{\"whole\": [(\"A\", 10), (\"B\", 11)]}",
);
Run
1.42.0 · source

pub fn key(&mut self, key: &dyn Debug) -> &mut Self

将新条目的关键部分添加到 map 输出中。

该方法与 value 一起,是 entry 的替代方法,可以在事先不知道完整条目的情况下使用。

尽可能使用 entry 方法。

Panics

key 必须在 value 之前调用,每个调用到 key 必须跟在对应的调用到 value 之后。 否则,此方法将为 panic。

Examples
use std::fmt;

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

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_map()
           .key(&"whole").value(&self.0) // 我们添加 "whole" 条目。
           .finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])),
    "{\"whole\": [(\"A\", 10), (\"B\", 11)]}",
);
Run
1.42.0 · source

pub fn value(&mut self, value: &dyn Debug) -> &mut Self

将新条目的值部分添加到 map 输出中。

该方法与 key 一起,是 entry 的替代方法,可以在事先不知道完整条目的情况下使用。

尽可能使用 entry 方法。

Panics

key 必须在 value 之前调用,每个调用到 key 必须跟在对应的调用到 value 之后。 否则,此方法将为 panic。

Examples
use std::fmt;

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

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_map()
           .key(&"whole").value(&self.0) // 我们添加 "whole" 条目。
           .finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])),
    "{\"whole\": [(\"A\", 10), (\"B\", 11)]}",
);
Run
source

pub fn entries<K, V, I>(&mut self, entries: I) -> &mut Selfwhere K: Debug, V: Debug, I: IntoIterator<Item = (K, V)>,

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

Examples
use std::fmt;

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

impl fmt::Debug for Foo {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_map()
           // 我们将 vec 设为 map,因此每个条目的第一个字段将成为 "key"。
           .entries(self.0.iter().map(|&(ref k, ref v)| (k, v)))
           .finish()
    }
}

assert_eq!(
    format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])),
    "{\"A\": 10, \"B\": 11}",
);
Run
source

pub fn finish(&mut self) -> Result

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

Panics

key 必须在 value 之前调用,每个调用到 key 必须跟在对应的调用到 value 之后。 否则,此方法将为 panic。

Examples
use std::fmt;

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

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

assert_eq!(
    format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])),
    "{\"A\": 10, \"B\": 11}",
);
Run

Auto Trait Implementations§

§

impl<'a, 'b> !RefUnwindSafe for DebugMap<'a, 'b>

§

impl<'a, 'b> !Send for DebugMap<'a, 'b>

§

impl<'a, 'b> !Sync for DebugMap<'a, 'b>

§

impl<'a, 'b> Unpin for DebugMap<'a, 'b>

§

impl<'a, 'b> !UnwindSafe for DebugMap<'a, 'b>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

获取 selfTypeIdRead more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

从拥有的值中一成不变地借用。 Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

从拥有的值中借用。 Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

返回未更改的参数。

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

调用 U::from(self)

也就是说,这种转换是 From<T> for U 实现选择执行的任何操作。

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

发生转换错误时返回的类型。
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

执行转换。
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

发生转换错误时返回的类型。
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

执行转换。