dfmt 0.4.1

A fully featured dynamic template drop in replacement for the format! 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

/// Dynamic drop in `format!` replacement.
/// ```rust
/// use dfmt::*;
///
/// let template = "This example template {contains:*^width$} multiple {{{0}}}
///     named and {} indexed args {0:+020o} {3:#?} {:.*}.";
/// let precompiled_template = Template::parse(template).unwrap();
///
/// dformat!(template, contains = "STH", 42, 3, 3.1423223, template, width=50).unwrap();
/// dformat!(precompiled_template, contains = "STH", 42, 3, 3.1423223, template, width=50).unwrap();
///
/// // Use `format!` under the hood
/// dformat!("Hello, {}!", "World").unwrap();
/// ```
///
/// ## Supported features
/// | Name | Feature |
/// | ---- | ------- |
/// | Fill/Alignment | `<`, `^`, `>` |
/// | Sign | `+`, `-` |
/// | Alternate | `#` |
/// | Zero-padding | `0` |
/// | Width | `{:20}`, `{:width$}` |
/// | Precision | `{:.5}`, `{:.precision$}`, `{:*}` |
/// | Type | `?`, `x`, `X`, `o`, `b`, `e`, `E`, `p` |
/// | Argument keys | `{}`, `{0}`, `{arg}` |
#[cfg(feature = "std")]
#[macro_export]
macro_rules! dformat {
    ($template:literal, $($args:tt)*) => {{
        #[cfg(not(feature = "std"))]
        use alloc::format;

        Ok(format!($template, $($args)*)) as Result<String, $crate::Error>
    }};
    ($template:expr, $($args:tt)*) => {
        $crate::__internal__dfmt!(true, $template, $($args)*)
    };
}

#[cfg(not(feature = "std"))]
#[macro_export]
macro_rules! dformat {
    ($template:literal, $($args:tt)*) => {{
        Ok(alloc::format!($template, $($args)*)) as Result<String, $crate::Error>
    }};
    ($template:expr, $($args:tt)*) => {
        $crate::__internal__dfmt!(true, $template, $($args)*)
    };
}

/// Dynamic drop in `format!` replacement. Unchecked variant.
/// ```rust
/// dfmt::dformat_unchecked!("Hello, {}!", "World");
/// dfmt::dformat_unchecked!("Hello, {}!".to_string(), "World");
/// ```
/// Refer to the [`dformat!()`][$crate::dformat] documentation for the full API overview.
#[cfg(feature = "std")]
#[macro_export]
macro_rules! dformat_unchecked {
    ($template:literal, $($args:tt)*) => {{
        format!($template, $($args)*)
    }};
    ($template:expr, $($args:tt)*) => {
        $crate::__internal__dfmt!(false, $template, $($args)*).unwrap()
    };
}

#[cfg(not(feature = "std"))]
#[macro_export]
macro_rules! dformat_unchecked {
    ($template:literal, $($args:tt)*) => {{
        alloc::format!($template, $($args)*)
    }};
    ($template:expr, $($args:tt)*) => {
        $crate::__internal__dfmt!(false, $template, $($args)*).unwrap()
    };
}