advise 0.1.0

User-friendly status reporting
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

/// Prints advise to [stderr][`std::io::stderr`].
///
/// Advise at the specified [tag][`super::Render`] with message body created
/// using a [`format!`]-based argument list.
///
/// # Examples
///
/// ```
/// use advise::advise;
/// use log::Level;
///
/// # fn main() {
/// let data = (42, "Forty-two");
///
/// advise!(Level::Error, "Received errors: {}, {}", data.0, data.1);
/// # }
/// ```
///
/// Produces:
///
/// <pre>
/// <b><span style=color:red>error</span>:</b> Received errors: 42, Forty-two
/// </pre>
#[macro_export]
macro_rules! advise {
    ($tag:expr, $($arg:tt)*) => {
        $crate::anstream::eprintln!("{}", $crate::Advise::new($tag, format!($($arg)*)))
    }
}

/// Advises about an [error][`log::Level::Error`] message.
///
/// # Examples
///
/// ```
/// use advise::error;
///
/// # fn main() {
/// let (err_info, port) = ("No connection", 22);
///
/// error!("{} on port {}", err_info, port);
/// # }
/// ```
///
/// Produces:
///
/// <pre>
/// <b><span style=color:red>error</span>:</b> No connection on port 22
/// </pre>
#[macro_export]
macro_rules! error {
    // error!("a {} event", "log")
    ($($arg:tt)*) => ($crate::advise!($crate::log::Level::Error, $($arg)*))
}

/// Advises about a [warning][`log::Level::Warn`] message.
///
/// # Examples
///
/// ```
/// use advise::warn;
///
/// # fn main() {
/// let warn_description = "Invalid Input";
///
/// warn!("{}!", warn_description);
/// # }
/// ```
///
/// Produces:
///
/// <pre>
/// <span style=color:orange>warn</span><b>:</b> Invalid Input!
/// </pre>
#[macro_export]
macro_rules! warn {
    // warn!("a {} event", "log")
    ($($arg:tt)*) => ($crate::advise!($crate::log::Level::Warn, $($arg)*))
}

/// Advises about an [info][`log::Level::Info`] message.
///
/// # Examples
///
/// ```
/// use advise::info;
///
/// # fn main() {
/// # struct Connection { port: u32, speed: f32 }
/// let conn_info = Connection { port: 40, speed: 3.20 };
///
/// info!("Connected to port {} at {} Mb/s", conn_info.port, conn_info.speed);
/// # }
/// ```
///
/// Produces:
///
/// <pre>
/// <span style=color:green>info</span><b>:</b> Connected to port 40 at 3.2 MB/s
/// </pre>
#[macro_export]
macro_rules! info {
    // info!("a {} event", "log")
    ($($arg:tt)*) => ($crate::advise!($crate::log::Level::Info, $($arg)*))
}

/// Advises about a [debug][`log::Level::Debug`] message.
///
/// # Examples
///
/// ```
/// use advise::debug;
///
/// # fn main() {
/// # struct Position { x: f32, y: f32 }
/// let pos = Position { x: 3.234, y: -1.223 };
///
/// debug!("New position: x: {}, y: {}", pos.x, pos.y);
/// # }
/// ```
///
/// Produces:
///
/// <pre>
/// <span style=color:blue>debug</span><b>:</b> New position: x: 3.234, y: -1.223
/// </pre>
#[macro_export]
macro_rules! debug {
    // debug!("a {} event", "log")
    ($($arg:tt)*) => ($crate::advise!($crate::log::Level::Debug, $($arg)*))
}

/// Advises about a [trace][`log::Level::Trace`] message.
///
/// # Examples
///
/// ```
/// use advise::trace;
///
/// # fn main() {
/// # struct Position { x: f32, y: f32 }
/// let pos = Position { x: 3.234, y: -1.223 };
///
/// trace!("Position is: x: {}, y: {}", pos.x, pos.y);
/// # }
/// ```
///
/// Produces:
///
/// <pre>
/// <span style=color:magenta>trace</span><b>:</b> Position is: x: 3.234, y: -1.223
/// </pre>
#[macro_export]
macro_rules! trace {
    // trace!("a {} event", "log")
    ($($arg:tt)*) => ($crate::advise!($crate::log::Level::Trace, $($arg)*))
}