#macro #syntactic #loops #expression #body

macro syntactic-for

语法 'for' 循环宏

2个版本

0.1.1 2023年1月17日
0.1.0 2022年12月2日

#1614 in 过程宏

Download history 4207/week @ 2024-03-14 2453/week @ 2024-03-21 2732/week @ 2024-03-28 3849/week @ 2024-04-04 1780/week @ 2024-04-11 2894/week @ 2024-04-18 2011/week @ 2024-04-25 2351/week @ 2024-05-02 1982/week @ 2024-05-09 2709/week @ 2024-05-16 3070/week @ 2024-05-23 4769/week @ 2024-05-30 3086/week @ 2024-06-06 1783/week @ 2024-06-13 2972/week @ 2024-06-20 2078/week @ 2024-06-27

10,983 每月下载量
range-set-blaze 中使用

MIT 许可证

15KB
148

syntactic-for

crates.io docs.rs

一个语法 "for" 循环Rust宏。

例如,以下代码计算四种整型位长度的总和

let sum = syntactic_for!{ ty in [ u8, u16, u32, u64 ] {
    [$( <$ty>::BITS ),*].into_iter().sum::<u32>()
}};
assert_eq!(sum, 120);

用法

语法如下

syntactic_for!{ IDENTIFIER in [ EXPRESSION, EXPRESSION, ... ] {
    BODY
}}

其中 BODYmacro_rules! 类似,即:$($IDENTIFIER)SEPARATOR* 将展开并替换 IDENTIFIER 为每个 EXPRESSION,用 SEPARATOR 分隔展开的内容。

SEPARATOR 可以是任何非 * 标点符号。因此,上面的例子也可以不使用迭代器来编写

$( <$ty>::BITS )+*

示例

循环展开

使用 循环展开 计算数组元素的总和

let array = b"oh my, I am getting summed!";
let mut acc = 0u32;
let mut i = 0;
while i <= array.len()-4 {
    syntactic_for!{ offset in [ 0, 1, 2, 3 ] {$(
        acc += array[i + $offset] as u32;
    )*}}
    i += 4;
}
for j in i..array.len() {
    acc += array[j] as u32;
}
assert_eq!(acc, 2366);

匹配

找到给定位大小的整型类型中的最大值

let max_size = syntactic_for!{ ty in [ u8, u16, u32, u64, u128 ] {
    match bit_size {
        $(<$ty>::BITS => <$ty>::MAX as u128,)*
        other => panic!("No integer of size {other}"),
    }
}};

impl

为一系列类型实现一个特质

syntactic_for!{ ty in [ u8, u16, u32, u64, u128 ] {$(
    impl MyTrait for $ty {
        // snip.
    }
)*}}

自定义语法循环

一个有用的设计模式是定义一个自定义宏,它展开为对给定表达式集的语法循环

#[doc(hidden)]
pub extern crate syntactic_for;

#[macro_export]
macro_rules! for_each_custom_type {
    ($ident:ident { $($tt:tt)* }) => {
        $crate::syntactic_for::syntactic_for! { $ident in [
            $crate::CustomType1,
            $crate::CustomType2,
            // etc.
        ] { $($tt)* } }
    }
}

例如,一个库可以通过将 for_each_custom_type 暴露出来,让用户能够编写在库中定义的类型集上的语法循环。这样,就可以在库内部添加类型到循环中,而不需要用户端进行任何更改

// Try and parse each library type in succession, stopping at the first
// success:
fn can_parse(input: &str) -> bool {
    my_library::for_each_custom_type! { ty {
        $(if let Ok(parsed) = <$ty>::parse(input) {
            return true;
        })*
    }}
    return false;
}

依赖关系

~1.5MB
~35K SLoC