@符号在声明性宏中是什么意思?

时间:2019-01-28 16:31:51

标签: syntax rust rust-macros rust-decl-macros

我已经看到在宏中使用了@符号,但是在Rust Book或任何官方文档或博客文章中找不到该符号。例如,在this Stack Overflow answer中,它的用法如下:

macro_rules! instructions {
    (enum $ename:ident {
        $($vname:ident ( $($vty: ty),* )),*
    }) => {
        enum $ename {
            $($vname ( $($vty),* )),*
        }

        impl $ename {
            fn len(&self) -> usize {
                match self {
                    $($ename::$vname(..) => instructions!(@count ($($vty),*))),*
                }
            }
        }
    };

    (@count ()) => (0);
    (@count ($a:ty)) => (1);
    (@count ($a:ty, $b:ty)) => (2);
    (@count ($a:ty, $b:ty, $c:ty)) => (3);
}

instructions! {
    enum Instruction {
        None(),
        One(u8),
        Two(u8, u8),
        Three(u8, u8, u8)
    }
}

fn main() {
    println!("{}", Instruction::None().len());
    println!("{}", Instruction::One(1).len());
    println!("{}", Instruction::Two(1, 2).len());
    println!("{}", Instruction::Three(1, 2, 3).len());
}

从用法上看,它似乎是用于声明另一个位于主宏本地的宏。

这个符号是什么意思?为什么要使用它而不是仅仅创建另一个顶级宏?

1 个答案:

答案 0 :(得分:8)

在宏的模式匹配部分中,符号可以表示作者希望它们表示的任何含义。前导符号@通常用于表示宏的“实现细节”,宏是外部用户不希望使用的宏的一部分。

在此示例中,我使用它对元组参数进行模式匹配以获取元组参数的计数。

在宏之外,@符号用于匹配模式,同时还为整个模式分配名称:

match age {
    x @ 0 => println!("0: {}", x),
    y @ 1 => println!("1: {}", y),
    z => println!("{}", z),
}

稍加拉伸,就可以将相同的逻辑应用于宏中的使用—我们正在对元组进行模式匹配,但也为该特定模式附加了名称。我认为我什至看到人们使用更平行的东西:(count @ ...。但是,The Little Book of Rust Macros指出:

  

使用@的原因是,从Rust 1.2开始,@标记不在前缀位置使用;因此,它不能与任何东西冲突。可以根据需要使用其他符号或唯一前缀,但是@的使用已经开始普及,因此使用它可以帮助读者理解您的代码。


  

不仅仅是创建另一个顶级宏

创建另一个宏可能是更好的做法,但仅限于现代Rust。在最近对Rust进行更改(使您可以直接导入宏)之前,对于试图选择性导入宏的最终用户而言,拥有多个宏可能会很棘手。

另请参阅: