devela/code/util/
items.rs

Help
1// devela::code::util::items
2//
3//! skip formatting macros
4//
5
6/// *`s`kip `f`ormatting* wrapper macro.
7///
8/// Preserves the formatting of the code provided as arguments, by relying on
9/// the fact that `rustfmt` does not usually apply formatting inside macros.
10///
11/// *Rust will format macros only if they use parenthesis `()` and the input is
12/// separated by commas, then it formats is the same way as function call.*
13///
14/// This macro can be used as an alternative to the `#[rustfmt::skip]` attribute,
15/// specially in places where it can't be applied yet on stable rust.
16///
17/// # Examples
18/// ```
19/// # use devela::sf;
20/// // rustfmt has no powers here
21/// sf! { println!(); for i in 0..3 { print!{"{i} "} } println!(); }
22/// ```
23#[macro_export]
24#[cfg_attr(cargo_primary_package, doc(hidden))]
25macro_rules! sf { ( $($line:tt)+ ) => { $($line)+ }; }
26#[doc(inline)]
27pub use sf;
28
29/// Groups items together and expands them as if they were written directly.
30///
31/// It can be useful to apply an attribute to a group of items.
32///
33/// It can also preserve the formatting of the code provided as arguments,
34/// but the [`sf`] macro is better for that, since it works with any arbitrary
35/// code sequences like statements, expressions… instead of with just Rust items.
36///
37/// # Examples
38/// ```
39/// # use devela::items;
40/// #[cfg(feature = "std")]
41/// items! {
42///     mod something {
43///         pub struct SomeThing;
44///     }
45///     pub use something::SomeThing;
46/// }
47/// ```
48#[macro_export]
49#[cfg_attr(cargo_primary_package, doc(hidden))]
50macro_rules! items { ( $($item:item)* ) => { $($item)* }; }
51#[doc(inline)]
52pub use items;
devela/code/util/items.rs

devela/code/util/
items.rs
