首页 > 解决方案 > 有没有办法在 proc-macro crate 中具有公共特征?

问题描述

我有一个带有宏的 proc-macro crate,当扩展时,需要为 Rust 内置类型使用自定义 trait 实现。我试图在同一个 crate 中定义 trait,但 Rust 告诉我一个 proc-macro crate 只能有公共宏(用 注释的函数#[proc_macro]),其他都不能是公共的。所以我把 trait 放在另一个 crate 中,并在 proc-macro crate 中将它作为依赖项包含在内。但这意味着任何想要使用我的 proc-macro crate 的人也必须依赖另一个 trait crate。

所以我想知道是否有一种方法可以向 proc-macro crate 添加公共 trait,或者以某种方式使 proc-macro 和 trait crate 链接起来,这样最终用户就不能尝试在没有另一个的情况下使用一个?如果两者都不可能,唯一的解决方案是记录依赖关系,这有点脆弱。

标签: rusttraitsrust-cratesrust-proc-macros

解决方案


通常处理这种情况的方式是让用户完全不依赖于您的 proc-macro crate。

您的问题可以用 3 个板条箱解决:

  • 包含 proc-macro 使用的类型和特征定义的“内部”板条箱
  • proc-宏箱:
    • 取决于内部 crate,所以它可以使用它的类型和特征
  • “公共”箱子:
    • 取决于内部和 proc-macro crates
    • 重新导出您希望用户使用的所有类型、特征和宏

每当您的宏在其生成的代码中提及共享类型时,您需要使用完全限定名称,这样用户就不需要导入它们。


这种模式在野外的一些流行示例:

  • thiserror取决于thiserror-impl哪个包含实际的宏
  • pin-project取决于pin-project-internal哪个再次包含宏
  • darling取决于darling-coreand darling-macro,它本身也取决于darling-core

推荐阅读