devela/text/fmt/
reexports.rs

1// devela::text::fmt::reexports
2//
3//!
4//
5
6use crate::reexport;
7
8/* macros */
9
10reexport! { rust: core,
11    doc: "Constructs parameters for the other string-formatting macros.",
12    format_args
13}
14reexport! { rust: core,
15    doc: "Writes formatted data into a buffer.",
16    write
17}
18reexport! { rust: core,
19    doc: "Writes formatted data into a buffer, with a newline appended.",
20    writeln
21}
22
23reexport! { rust: alloc,
24    doc: "Creates a String using interpolation of runtime expressions.",
25    format
26}
27
28/* traits */
29
30reexport! { rust: core::fmt,
31    doc: "`b` formatting.",
32    Binary
33}
34reexport! { rust: core::fmt,
35    doc: "`?` formatting.",
36    Debug
37}
38reexport! { rust: core::fmt,
39    doc: "Format trait for an empty format, `{}`.",
40    Display
41}
42reexport! { rust: core::fmt,
43    doc: "`e` formatting.",
44    LowerExp
45}
46reexport! { rust: core::fmt,
47    doc: "`x` formatting.",
48    LowerHex
49}
50reexport! { rust: core::fmt,
51    doc: "`o` formatting.",
52    Octal
53}
54reexport! { rust: core::fmt,
55    doc: "`p` formatting.",
56    Pointer
57}
58reexport! { rust: core::fmt,
59    doc: "`E` formatting.",
60    UpperExp
61}
62reexport! { rust: core::fmt,
63    doc: "`X` formatting.",
64    UpperHex
65}
66reexport! { rust: core::fmt,
67    doc: "Writing or formatting into Unicode-accepting buffers or streams.",
68    @Write as FmtWrite
69}
70
71/* enums */
72
73reexport! { rust: core::fmt,
74    doc: "Possible alignments returned by `Formatter::align`.",
75    @Alignment as FmtAlignment
76}
77
78/* aliases */
79
80#[doc = crate::TAG_RESULT!()]
81/// The type returned by formatter methods.
82///
83/// Note that this is not the same as [`core::fmt::Result`], since this one
84/// doesn't hardcode the returned type to `()`.
85pub type FmtResult<T> = Result<T, FmtError>;
86
87/* structs */
88
89reexport! { rust: core::fmt,
90    doc: "Represents a safely precompiled version of a format string and its arguments.",
91    @Arguments as FmtArguments
92}
93reexport! { rust: core::fmt,
94    doc: "A struct to help with [`Debug`] implementations.",
95    DebugList
96}
97reexport! { rust: core::fmt,
98    doc: "A struct to help with [`Debug`] implementations.",
99    DebugMap
100}
101reexport! { rust: core::fmt,
102    doc: "A struct to help with [`Debug`] implementations.",
103    DebugSet
104}
105reexport! { rust: core::fmt,
106    doc: "A struct to help with [`Debug`] implementations.",
107    DebugStruct
108}
109reexport! { rust: core::fmt,
110    doc: "A struct to help with [`Debug`] implementations.",
111    DebugTuple
112}
113reexport! { rust: core::fmt,
114    tag: crate::TAG_ERROR!(),
115    doc: "The error type which is returned from formatting a message into a stream.",
116    @Error as FmtError
117}
118reexport! { rust: core::fmt,
119    doc: "Configuration for formatting.",
120    Formatter
121}