纳德

英文 | 简体中文

nade 是一个属性宏，用于为 Rust 函数添加命名和默认参数。

用法

// some_crate/src/lib.rs
pub use nade::base::*;
use nade::nade;

pub fn one() -> u32 {
    1
}

#[nade]
pub fn foo(
    /// You can add doc comments to the parameter. It will be shown in the doc of the macro.
    ///
    /// The world is 42.
    #[nade(42)] a: u32,

    /// Call a function
    #[nade(one())] b: u32,

    /// Default value of u32
    #[nade] c: u32,

    d: u32
) -> u32 {
    a + b + c + d
}

assert_eq!(foo!(1, 2, 3, 4), 10);         // foo(1,  2,     3,                  4)
assert_eq!(foo!(d = 2), 45);              // foo(42, one(), Default::default(), 2)
assert_eq!(foo!(1, c = 2, b = 3, 4), 10); // foo(1,  3,     2,                  4)

工作原理

如果你编写了一个像这样的函数

// some_crate/src/lib.rs
pub use nade::base::*;
use nade::nade;

pub fn one() -> u32 {
    1
}

#[nade]
pub fn foo(
    #[nade(42)]
    a: u32,

    #[nade(one())]
    b: u32,

    #[nade]
    c: u32,

    d: u32
) -> u32 {
    a + b + c + d
}

它将被扩展为

// some_crate/src/lib.rs
// ⓵
pub use nade::base::*;
use nade::nade;

pub fn one() -> u32 {
    1
}

pub fn foo(a: u32, b: u32, c: u32, d: u32) -> u32 {
    a + b + c + d
}

// ⓶
#[::nade::__internal::macro_v(pub)]
macro_rules! foo {
    ($($arguments:tt)*) => {
        // ⓷
        $crate::nade_helper!(
            ($($arguments)*)
            (a: u32 = 42, b: u32 = one(), c: u32 = Default::default(), d: u32)
            (foo)
        )
    };
}

然后，当你像这样调用宏 foo 时

use some_crate::{foo, one};

foo!(32, d = 1, c = 2);

它将被扩展为

use some_crate::{foo, one};

foo(32, one(), 2, 1);

注意

如工作原理中所示，在 #[nade] 生成的代码中，有 3 件事情需要注意。

• ⓵, ⓷

  nade_helper 是一个声明式宏，用于基于参数、参数和函数路径生成函数调用表达式。

  它的路径默认为 $crate::nade_helper，因此您需要使用 pub use nade::base::*; 或 pub use nade::base::nade_helper; 在 crate 的根目录中导入宏。

  您还可以自定义 nade_helper 的路径。

  use nade::nade;
  
  mod custom_nade_helper {
      pub use nade::base::nade_helper;
  }
  
  #[nade]
  #[nade_path(nade_helper = custom_nade_helper)]
  fn custom_nade_helper_path(a: usize) -> usize {
      a
  }
  

• ⓶

  macro_v 是一个属性宏，使声明式宏的可见性与函数相同。有关详细信息，请参阅 macro-v。

  它的路径默认为 ::nade::__internal::macro_v。

  您还可以自定义 macro_v 的路径。

  use nade::nade;
  
  mod custom_macro_v {
      pub use nade::__internal::macro_v;
  }
  
  #[nade]
  #[nade_path(macro_v = custom_macro_v)]
  fn custom_macro_v_path(a: usize) -> usize {
      a
  }