Rust宏展开本地歧义报错分析及解决方法

问题场景 #

需要实现一个Rust宏，自动为TestTrait生成实现代码，要求关联类型ExtraData未指定时默认设为单元类型()，但当前宏代码运行时触发了歧义错误。

原代码如下：

pub trait TestTrait {
    type ExtraData;
    fn test(&self, _state: &Self::ExtraData) {}
    fn test_a(&self, _state: Self::ExtraData) {}
}

pub struct Data;

#[macro_export]
macro_rules! type_or_unit {
    () => { () };
    ($name:ty) => { $name };
}

#[macro_export]
macro_rules! expand {
    {
        pub struct $example_type:ident;

        impl TestTrait for $example_type1:ident {
            $(type ExtraData = $extra_state:ty;)?
            $($impls:tt)*
        }
    } => {
        pub struct $example_type;

        impl TestTrait for $example_type1 {
            type ExtraData = $crate::type_or_unit! {$( $extra_state )?};
            $($impls)*
        }
    }
}


fn main() {
    expand!{
        pub struct Test;

        impl TestTrait for Test {
            type ExtraData = ();
        }
    }
}

报错信息：

error: local ambiguity when calling macro `expand`: multiple parsing options: built-in NTs tt ('impls') or 1 other option.
  --> src/main.rs:41:13
   |
41 |             type ExtraData = ();

报错原因 #

宏解析器无法明确区分可选片段$(type ExtraData = $extra_state:ty;)?和后续的$($impls:tt)*。因为tt（token tree）可以匹配任意语法片段，当存在type ExtraData = ();时，解析器既可以把它归为前面的可选关联类型定义，也可以把它当成$impls的一部分，直接导致匹配歧义。

解决方案 #

方案一：拆分宏分支，明确匹配场景 #

直接把宏拆分成两个分支，分别处理“指定了ExtraData”和“未指定ExtraData”的情况，彻底消除歧义：

pub trait TestTrait {
    type ExtraData;
    fn test(&self, _state: &Self::ExtraData) {}
    fn test_a(&self, _state: Self::ExtraData) {}
}

pub struct Data;

#[macro_export]
macro_rules! type_or_unit {
    () => { () };
    ($name:ty) => { $name };
}

#[macro_export]
macro_rules! expand {
    // 分支1：匹配指定了ExtraData的情况
    {
        pub struct $example_type:ident;

        impl TestTrait for $example_type1:ident {
            type ExtraData = $extra_state:ty;
            $($impls:tt)*
        }
    } => {
        pub struct $example_type;

        impl TestTrait for $example_type1 {
            type ExtraData = $extra_state;
            $($impls)*
        }
    };
    // 分支2：匹配未指定ExtraData的情况
    {
        pub struct $example_type:ident;

        impl TestTrait for $example_type1:ident {
            $($impls:tt)*
        }
    } => {
        pub struct $example_type;

        impl TestTrait for $example_type1 {
            type ExtraData = ();
            $($impls)*
        }
    };
}


fn main() {
    // 测试指定ExtraData的场景
    expand!{
        pub struct Test;

        impl TestTrait for Test {
            type ExtraData = ();
        }
    }

    // 测试未指定ExtraData的场景
    expand!{
        pub struct Test2;

        impl TestTrait for Test2 {
            fn test(&self, _state: &Self::ExtraData) {
                println!("Test2's test method");
            }
        }
    }
}

方案二：用精确捕获替代模糊的tt #

如果不想拆分分支，可以把$($impls:tt)*替换成更具体的捕获规则，比如只匹配方法定义（适合Trait结构固定的场景）：

#[macro_export]
macro_rules! expand {
    {
        pub struct $example_type:ident;

        impl TestTrait for $example_type1:ident {
            $(type ExtraData = $extra_state:ty;)?
            $(fn $method:ident(&self, $($args:tt)*) $body:block)*
        }
    } => {
        pub struct $example_type;

        impl TestTrait for $example_type1 {
            type ExtraData = $crate::type_or_unit! {$( $extra_state )?};
            $(fn $method(&self, $($args)*) $body)*
        }
    }
}

方案说明 #

• 方案一通用性更强，能适配Trait内任意合法代码（除额外关联类型定义）；
• 方案二通过限制捕获内容消除歧义，适合Trait方法结构固定的场景。

内容的提问来源于stack exchange，提问作者jajajaxxx