custom-print 0.1.0

Define custom println and dbg macros in wasm and other targets
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

/// Defines a `dbg`-like macro with a given name that uses
/// specified write macro, error-handling policy, format string and writer.
///
/// The implementation of the generated `dbg`-like macro
/// is based on [`std::dbg`] macro implementation,
/// but the exact output printed by [`std::dbg`]
/// should not be relied upon and is subject to future changes.
///
/// If the `try` policy is used, it propagates write error and
/// returns values wrapper into `Result`.
///
/// The writer itself is specified by the rest arguments with the [`define_writer`] macros.
///
/// # Examples
///
/// ```rust
/// let mut string = String::new();
/// custom_print::define_dbglike!(cdbg, writeln, expect, ":?", fmt, |value: &str| string += value);
/// custom_print::define_dbglike!(try_dbg, writeln, try, ":?", fmt, |value: &str| string += value);
///
/// assert_eq!(cdbg!("first"), "first");
/// assert!(string.contains("\"first\""));
/// assert_eq!(try_dbg!("second"), Ok("second"));
/// assert!(string.contains("\"second\""));
/// ```
#[macro_export]
macro_rules! define_dbglike {
    ( $name:ident, $macro:path, expect, $format:literal, $($args:tt)* ) => {
        $crate::_define_dbglike_impl!(
            ($), $name, $macro, expect, $format, $crate::define_writer!($($args)*)
        );
    };
    ( $name:ident, $macro:path, try, $format:literal, $($args:tt)* ) => {
        $crate::_define_dbglike_impl!(
            ($), $name, $macro, try, $format, $crate::define_try_writer!($($args)*)
        );
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! _define_dbglike_impl {
    ( ($d:tt), $name:ident, $macro:path, $handler:tt, $format:literal, $writer:expr ) => {
        #[allow(unused_macros)]
        macro_rules! $name {
            // Dummy comment below is used to avoid rustfmt formatting bug.
            // Issue: https://github.com/rust-lang/rustfmt/issues/4609
            /* ================================================================================== */
            () => {
                $crate::dbgwrite!($macro, $writer, $handler, $format)
            };
            ($d ($d args:tt)+) => {
                $crate::dbgwrite!($macro, $writer, $handler, $format, $d ($d args)+)
            };
        }
    };
}