#macro #utility #template #macro-rules #lite #write #anywhere

macro buns

Create simple code templates - basically macro_rules lite

2 releases

0.1.2 Jan 12, 2025
0.1.1 Jan 12, 2025
0.1.0 Nov 11, 2024

#2207 in Procedural macros

Download history 132/week @ 2024-11-11 10/week @ 2024-11-18 1/week @ 2024-11-25 2/week @ 2024-12-09 28/week @ 2024-12-30 183/week @ 2025-01-06 111/week @ 2025-01-13 23/week @ 2025-01-20

345 downloads per month
Used in 11 crates (via deki_core)

MIT/Apache

11KB
155 lines

A simple way to write repeatable code anywhere, by defining buns and toppings. 🍞

Sandwich / Compose

This can be seen as format!(), but for code:

  1. Buns: Write the code, use ^0 ^1 .. ^N as (Topping) placeholders
  2. Topping: Write code inserts: #0^1^..^N, where numbers = any code
  3. Why tho? The point is, you can repeat 2. and make infinite sandwiches. 🥪
buns::sandwich!{ 
    const ^0: u32 = ^1; // Buns
    #TEST^10 #OMEGA^59  // Toppings
}
// Will generate:
// const TEST: u32 = 10;
// const OMEGA: u32 = 59;

Prepare / Preset

This can be seen as a simplified macro_rules!{}, where you prepare named Buns and add the Toppings later using the generated macro (The code (Buns) is automatically added to the macro documentation):

buns::prepare!{
    burger           // Name
    let a = ^0 + ^0; // Buns
    println!("{a}"); // "
}

fn main(){
    burger!{#1 #2 #4+4 #4 #2*2} // Toppings
    // prints: 2 4 16 8 8
}

Flexibility

You can use any other magical token macro like paste to add functionality:

buns::sandwich!{
    paste::paste!{const [<^1 _ ^0:upper>]: ^0 = ^2;}
    #u32^BREAD^100 #f32^BREAD^12.0
}
// Will generate:
// const BREAD_U32: u32 = 100;
// const BREAD_F32: f32 = 12.9;

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~2MB
~44K SLoC