debug_with_context 0.1.15

A Rust crate for context-aware `Debug` formatting via a custom derive macro
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

#![feature(debug_closure_helpers)]

// TODO : add a no-std feature to deactivate the parts that need std 

use std::{collections::HashMap, convert::Infallible, env::Args, ffi::{CStr, CString, OsStr, OsString}, fmt::{self, Debug}, ops::Deref, path::{Path, PathBuf}, str::Chars};

pub use debug_with_context_macros::DebugWithContext;

pub trait DebugWithContext<C> {
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result;
}

pub struct DebugWrapContext<'a, C, T> {
    value: &'a T,
    context: &'a C,
}

impl <'a, C, T> DebugWrapContext<'a, C, T> {
    pub fn new(value: &'a T, context: &'a C) -> DebugWrapContext<'a, C, T> {
        DebugWrapContext { value, context }
    }
}

impl<'a, C, T> Debug for DebugWrapContext<'a, C, T>
where
    T: DebugWithContext<C>,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.value.fmt_with_context(f, self.context)
    }
}

macro_rules! debug_with_context_debug {
    ($t:ty) => {
        impl <C> DebugWithContext<C> for $t {
            fn fmt_with_context(&self, f: &mut fmt::Formatter, _context: &C) -> fmt::Result {
                write!(f, "{:?}", self)
            }
        }
    };
    ($t1:ty, $($ts:ty),+) => {
        debug_with_context_debug!($t1);
        debug_with_context_debug!($($ts),+);
    }
}

// TODO : add types here ?
debug_with_context_debug!(bool, u8, i8, u16, i16, u32, i32, u64, i64, u128, i128, f32, f64, usize, isize, char, &str, String, ());
debug_with_context_debug!(Infallible, Args, CStr, CString, OsStr, OsString, Path, PathBuf);

/*impl <'a, C> DebugWithContext<C> for Chars<'a> {
    fn fmt_with_context(&self, f: &mut fmt::Formatter, _context: &C) -> fmt::Result {
        write!(f, "{:?}", self)
    }
}*/

// TODO : use a macro to create tuples for example to a bigger size
impl <C, T1, T2> DebugWithContext<C> for (T1, T2)
where 
    T1 : DebugWithContext<C>,
    T2 : DebugWithContext<C>
{
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        f.debug_tuple("").field_with(|fmt| self.0.fmt_with_context(fmt, context)).field_with(|fmt| self.1.fmt_with_context(fmt, context)).finish()
    }
}

#[inline]
fn fmt_with_context_collection<C, Col, T>(col : &Col, f : &mut fmt::Formatter, context : &C) -> fmt::Result
where 
    Col: Deref<Target = [T]>,
    T : DebugWithContext<C>,
{
    f.debug_list()
            .entries(col.iter().map(|item| DebugWrapContext { value: item, context }))
            .finish()
}

impl<C, T> DebugWithContext<C> for Vec<T>
where
    T: DebugWithContext<C>,
{
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        fmt_with_context_collection(self, f, context)
    }
}

impl<C, T> DebugWithContext<C> for &[T]
where
    T: DebugWithContext<C>,
{
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        fmt_with_context_collection(self, f, context)
    }
}

impl<C, T> DebugWithContext<C> for Box<[T]>
where
    T: DebugWithContext<C>,
{
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        fmt_with_context_collection(self, f, context)
    }
}

impl<C, T> DebugWithContext<C> for Option<T>
where
    T: DebugWithContext<C>,
{
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        match self {
            Some(s) => s.fmt_with_context(f, context),
            None => None::<()>.fmt(f),
        }
    }
}

impl<C, K, V, S> DebugWithContext<C> for HashMap<K, V, S> 
where 
    K : DebugWithContext<C>,
    V : DebugWithContext<C>,
{
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        f.debug_map()
            .entries(self.iter().map(|(k, v)| (
                DebugWrapContext::new(k, context), DebugWrapContext::new(v, context)
            )))
            .finish()
    }
}

impl<C, T> DebugWithContext<C> for &'_ T where T: DebugWithContext<C> {
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        (*self).fmt_with_context(f, context)
    }
}

impl<C, T> DebugWithContext<C> for &'_ mut T where T: DebugWithContext<C> {
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &C) -> fmt::Result {
        (**self).fmt_with_context(f, context)
    }
}