serdebug 1.2.0

serde-based replacement for #[derive(Debug)]
Documentation 
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

#![doc = include_str!("../README.md")]
#![no_std]

extern crate alloc;

mod debug;
mod error;
mod map;
mod seq;
mod structure;
mod tuple;

use alloc::format;
use alloc::string::String;
use core::fmt::{self, Debug, Formatter};
use serde::ser::{self, Serialize, SerializeTupleStruct};

pub use debug::debug;
pub use error::Error;
pub use serdebug_derive::SerDebug;

/// A [`Serializer`](::serde::Serializer)-compatible wrapper for a [`Formatter`].
pub struct Serializer<'a, 'b: 'a>(pub &'a mut Formatter<'b>);

macro_rules! simple_impl {
    ($(fn $name:ident ( $self: ident, $v:ident : $ty:ty ) -> $res:ty;)*) => {
        $(fn $name($self, $v: $ty) -> $res {
            Ok($v.fmt($self.0)?)
        })*
    };
}

impl<'a, 'b: 'a> ser::Serializer for Serializer<'a, 'b> {
    type Ok = ();
    type Error = Error;

    type SerializeSeq = seq::Serializer<'a, 'b>;
    type SerializeTuple = tuple::Serializer<'a, 'b>;
    type SerializeTupleStruct = tuple::Serializer<'a, 'b>;
    type SerializeTupleVariant = tuple::Serializer<'a, 'b>;
    type SerializeMap = map::Serializer<'a, 'b>;
    type SerializeStruct = structure::Serializer<'a, 'b>;
    type SerializeStructVariant = structure::Serializer<'a, 'b>;

    simple_impl! {
        fn serialize_bool(self, v: bool) -> Result<Self::Ok, Self::Error>;
        fn serialize_i8(self, v: i8) -> Result<Self::Ok, Self::Error>;
        fn serialize_i16(self, v: i16) -> Result<Self::Ok, Self::Error>;
        fn serialize_i32(self, v: i32) -> Result<Self::Ok, Self::Error>;
        fn serialize_i64(self, v: i64) -> Result<Self::Ok, Self::Error>;
        fn serialize_u8(self, v: u8) -> Result<Self::Ok, Self::Error>;
        fn serialize_u16(self, v: u16) -> Result<Self::Ok, Self::Error>;
        fn serialize_u32(self, v: u32) -> Result<Self::Ok, Self::Error>;
        fn serialize_u64(self, v: u64) -> Result<Self::Ok, Self::Error>;
        fn serialize_f32(self, v: f32) -> Result<Self::Ok, Self::Error>;
        fn serialize_f64(self, v: f64) -> Result<Self::Ok, Self::Error>;
        fn serialize_char(self, v: char) -> Result<Self::Ok, Self::Error>;
        fn serialize_str(self, v: &str) -> Result<Self::Ok, Self::Error>;
        fn serialize_bytes(self, v: &[u8]) -> Result<Self::Ok, Self::Error>;
    }

    fn serialize_none(self) -> Result<Self::Ok, Self::Error> {
        self.serialize_unit_struct("None")
    }

    fn serialize_some<T: ?Sized + Serialize>(self, value: &T) -> Result<Self::Ok, Self::Error> {
        self.serialize_newtype_struct("Some", value)
    }

    fn serialize_unit(self) -> Result<Self::Ok, Self::Error> {
        Ok(().fmt(self.0)?)
    }

    fn serialize_unit_struct(self, name: &'static str) -> Result<Self::Ok, Self::Error> {
        self.serialize_tuple_struct(name, 0)?.end()
    }

    fn serialize_unit_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
    ) -> Result<Self::Ok, Self::Error> {
        self.serialize_unit_struct(variant)
    }

    fn serialize_newtype_struct<T: ?Sized + Serialize>(
        self,
        name: &'static str,
        value: &T,
    ) -> Result<Self::Ok, Self::Error> {
        let mut tuple = self.serialize_tuple_struct(name, 1)?;
        tuple.serialize_field(value)?;
        tuple.end()
    }

    fn serialize_newtype_variant<T: ?Sized + Serialize>(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
        value: &T,
    ) -> Result<Self::Ok, Self::Error> {
        self.serialize_newtype_struct(variant, value)
    }

    fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq, Self::Error> {
        Ok(seq::Serializer::new(self.0))
    }

    fn serialize_tuple_struct(
        self,
        name: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeTuple, Self::Error> {
        Ok(tuple::Serializer::new(self.0, name))
    }

    fn serialize_tuple(self, len: usize) -> Result<Self::SerializeTuple, Self::Error> {
        self.serialize_tuple_struct("", len)
    }

    fn serialize_tuple_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
        len: usize,
    ) -> Result<Self::SerializeTupleVariant, Self::Error> {
        self.serialize_tuple_struct(variant, len)
    }

    fn serialize_map(self, _len: Option<usize>) -> Result<Self::SerializeMap, Self::Error> {
        Ok(map::Serializer::new(self.0))
    }

    fn serialize_struct(
        self,
        name: &'static str,
        _len: usize,
    ) -> Result<Self::SerializeStruct, Self::Error> {
        Ok(structure::Serializer::new(self.0, name))
    }

    fn serialize_struct_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
        len: usize,
    ) -> Result<Self::SerializeStructVariant, Self::Error> {
        self.serialize_struct(variant, len)
    }
}

/// Format value's debug representation into a given [`Formatter`].
pub fn fmt<T: ?Sized + Serialize>(value: &T, f: &mut Formatter) -> fmt::Result {
    debug(value).fmt(f)
}

/// Convert value into a string with a concise debug representation.
pub fn to_string<T: ?Sized + Serialize>(value: &T) -> String {
    format!("{:?}", debug(value))
}

/// Pretty-print value into a string with a debug representation.
pub fn to_string_pretty<T: ?Sized + Serialize>(value: &T) -> String {
    format!("{:#?}", debug(value))
}