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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
#![doc(html_logo_url = "https://github.com/mingling-rs/mingling/raw/main/docs/res/icon3.png")]
#![doc(
html_favicon_url = "https://github.com/mingling-rs/mingling/raw/main/docs/res/favicon_small.png"
)]
#![deny(missing_docs)]
#![doc = include_str!("docs/lib.md")]
#![cfg_attr(docsrs, feature(doc_cfg))]
#[cfg(feature = "core")]
mod example_docs;
// Re-export Core lib
#[cfg(feature = "core")]
pub use mingling::*;
#[cfg(feature = "core")]
pub use mingling_core as mingling;
/// `Mingling` argument parser (Built-in)
#[cfg(feature = "parser")]
pub mod parser;
/// `Mingling` argument parser (Picker2)
#[cfg(feature = "picker")]
pub mod picker;
/// Functionality when combining `picker` and `comp`
#[cfg(all(feature = "picker", feature = "comp"))]
pub mod picker_comp;
mod constants;
/// Constants used throughout the Mingling framework.
pub mod consts {
pub use crate::constants::*;
}
/// Re-export of all macros from `mingling_macros`.
///
/// This module re-exports all macros provided by the `mingling_macros` crate,
/// including `dispatcher!`, `chain!`, `renderer!`,
/// `gen_program!`, `pack!`, and many others. These macros form the core
/// building blocks of the Mingling framework.
///
/// For detailed documentation, usage examples, and the full list of available
/// macros, please refer to the `mingling_macros` crate [documentation](https://docs.rs/mingling_macros/latest/mingling_macros/):
///
/// <https://docs.rs/mingling_macros/latest/mingling_macros/>
#[allow(unused_imports)]
#[cfg(feature = "macros")]
pub mod macros {
#[cfg(feature = "picker")]
pub use arg_picker::macros::*;
pub use mingling_macros::buffer;
pub use mingling_macros::chain;
#[cfg(feature = "extras")]
pub use mingling_macros::command;
#[cfg(feature = "comp")]
pub use mingling_macros::completion;
pub use mingling_macros::dispatcher;
#[cfg(feature = "clap")]
pub use mingling_macros::dispatcher_clap;
#[cfg(feature = "extras")]
pub use mingling_macros::empty_result;
#[cfg(feature = "extras")]
pub use mingling_macros::entry;
pub use mingling_macros::gen_program;
#[cfg(feature = "extras")]
pub use mingling_macros::group;
#[cfg(all(feature = "structural_renderer", feature = "extras"))]
pub use mingling_macros::group_structural;
pub use mingling_macros::help;
pub use mingling_macros::mlint;
pub use mingling_macros::node;
pub use mingling_macros::pack;
#[cfg(feature = "extras")]
pub use mingling_macros::pack_err;
#[cfg(all(feature = "structural_renderer", feature = "extras"))]
pub use mingling_macros::pack_err_structural;
#[cfg(feature = "structural_renderer")]
pub use mingling_macros::pack_structural;
#[cfg(feature = "comp")]
#[doc(hidden)]
pub use mingling_macros::program_comp_gen;
#[doc(hidden)]
pub use mingling_macros::program_fallback_gen;
#[doc(hidden)]
pub use mingling_macros::program_final_gen;
#[cfg(feature = "extras")]
pub use mingling_macros::program_setup;
pub use mingling_macros::r_append;
pub use mingling_macros::r_eprint;
pub use mingling_macros::r_eprintln;
pub use mingling_macros::r_print;
pub use mingling_macros::r_println;
#[doc(hidden)]
pub use mingling_macros::register_chain;
#[doc(hidden)]
pub use mingling_macros::register_dispatcher;
#[doc(hidden)]
pub use mingling_macros::register_help;
#[doc(hidden)]
pub use mingling_macros::register_renderer;
#[doc(hidden)]
pub use mingling_macros::register_type;
#[cfg(feature = "extras")]
pub use mingling_macros::render_route;
pub use mingling_macros::renderer;
#[cfg(feature = "extras")]
pub use mingling_macros::renderify;
#[cfg(feature = "extras")]
pub use mingling_macros::route;
#[cfg(feature = "extras")]
pub use mingling_macros::routeify;
#[cfg(feature = "comp")]
pub use mingling_macros::suggest;
#[cfg(feature = "comp")]
pub use mingling_macros::suggest_enum;
}
#[cfg(feature = "macros")]
pub use mingling_macros::EnumTag;
#[cfg(feature = "macros")]
pub use mingling_macros::Grouped;
#[cfg(feature = "structural_renderer")]
pub use mingling_macros::StructuralData;
#[doc = include_str!("docs/docsrs_examples.md")]
#[cfg(all(feature = "core", feature = "docs_rs"))]
#[allow(nonstandard_style)]
pub mod EXAMPLES {
pub use crate::example_docs::*;
}
#[cfg(feature = "core")]
mod features;
/// Module for checking which features are enabled at compile time.
///
/// Each constant re-exported from this module corresponds to a Cargo feature flag.
/// They can be used for conditional compilation or runtime branching based on
/// feature availability.
#[cfg(feature = "core")]
pub mod feature {
include!("./features.rs");
}
#[cfg(feature = "core")]
mod setups;
/// Setups provided by Mingling, which can extend command-line programs.
#[cfg(feature = "core")]
pub mod setup {
pub use crate::setups::*;
pub use mingling_core::setup::*;
}
/// Mutable global resources provided within Mingling
#[cfg(feature = "core")]
pub mod res;
/// The prelude module provides convenient re-exports of commonly used macros and traits.
///
/// Importing this module brings the essential components of Mingling into scope,
/// reducing boilerplate when defining commands, dispatchers, renderers, and the
/// program entry point.
///
/// # Examples
///
/// ```rust
/// use mingling::prelude::*;
/// ```
pub mod prelude {
#[cfg(feature = "core")]
pub use crate::Grouped;
#[cfg(feature = "core")]
pub use crate::RenderResult;
#[cfg(feature = "core")]
pub use crate::Routable;
#[cfg(feature = "macros")]
pub use crate::macros::chain;
#[cfg(all(feature = "extras", feature = "macros"))]
pub use crate::macros::command;
#[cfg(feature = "macros")]
pub use crate::macros::dispatcher;
#[cfg(all(feature = "extras", feature = "macros"))]
pub use crate::macros::empty_result;
#[cfg(feature = "macros")]
pub use crate::macros::gen_program;
#[cfg(feature = "macros")]
pub use crate::macros::pack;
#[cfg(all(feature = "extras", feature = "macros"))]
pub use crate::macros::pack_err;
#[cfg(feature = "macros")]
pub use crate::macros::renderer;
#[cfg(all(
feature = "macros",
feature = "structural_renderer",
feature = "extras"
))]
pub use mingling_macros::pack_err_structural;
#[cfg(all(feature = "macros", feature = "structural_renderer"))]
pub use mingling_macros::pack_structural;
pub use mingling_macros::r_append;
pub use mingling_macros::r_eprint;
pub use mingling_macros::r_eprintln;
pub use mingling_macros::r_print;
pub use mingling_macros::r_println;
#[cfg(all(feature = "macros", feature = "comp"))]
pub use crate::macros::completion;
#[cfg(feature = "parser")]
pub use crate::parser::AsPicker;
#[cfg(feature = "picker")]
pub use arg_picker::prelude::arg;
#[cfg(feature = "picker")]
pub use crate::picker::EntryPicker;
}
|
