跳到主要内容

Rust 函数式过程宏

rust function-like macros

本教程解释了函数和函数式宏之间的区别。例如,为什么msg!后面有一个感叹号?本教程将解释这种语法。

作为一种强类型语言,Rust 不能接受任意数量的函数参数。

例如,Python 的print函数可以接受任意数量的参数:

print(1)
print(1, 2)
print(1, 2, 3)

! 表示这个“函数”是一个函数式宏。

Rust 函数式宏通过!符号来识别,例如在 Solana 中的println!(...)msg!(...)

在 Rust 中,用于打印内容的常规函数(而不是函数式宏)是std::io::stdout().write,它只接受一个单字节字符串作为参数。

如果你想运行以下代码,Rust Playground 是一个方便的工具,不需要设置开发环境了。

让我们使用以下示例(来自这里 ):

use std::io::Write;

fn main() {
std::io::stdout().write(b"Hello, world!\n").unwrap();
}

请注意,write 是一个函数,而不是宏,因为它没有!

如果你尝试在 Python 中执行我们上面的操作,代码将无法编译,因为write只接受一个参数:

// this does not compile
use std::io::Write;

fn main() {
std::io::stdout().write(b"1\n").unwrap();
std::io::stdout().write(b"1", b"2\n").unwrap();
std::io::stdout().write(b"1", b"2", b"3\n").unwrap();
}

因此,如果你希望打印任意数量的参数,你需要编写一个自定义打印函数来处理每种情况下的每个参数数量 —— 这是极其低效的!

这样的代码如下所示(这是极不推荐的!):

use std::io::Write;

// print one argument
fn print1(arg1: &[u8]) -> () {
std::io::stdout().write(arg1).unwrap();
}

// print two arguments
fn print2(arg1: &[u8], arg2: &[u8]) -> () {
let combined_vec = [arg1, b" ", arg2].concat();
let combined_slice = combined_vec.as_slice();
std::io::stdout().write(combined_slice).unwrap();
}

// print three arguments
fn print3(arg1: &[u8], arg2: &[u8], arg3: &[u8]) -> () {
let combined_vec = [arg1, b" ", arg2, b" ", arg3].concat();
let combined_slice = combined_vec.as_slice();
std::io::stdout().write(combined_slice).unwrap();
}

fn main() {
print1(b"1\n");
print2(b"1", b"2\n");
print3(b"1", b"2", b"3\n");
}

如果我们在print1print2print3函数中寻找模式,它只是将参数插入向量中,并在它们之间添加一个空格,然后将向量转换回字节字符串(准确地说是字节切片)。

如果我们能够将类似println!的代码片段自动扩展为一个打印函数,该函数将接受我们需要的参数数量,那不是很好吗?

这就是 Rust 宏的作用。

Rust 宏将 Rust 代码作为输入,并将其程序化地扩展为更多的 Rust 代码。

这有助于我们避免为代码所需的每种打印语句编写打印函数的无聊工作。

扩展宏

要查看 Rust 编译器如何扩展println!宏的示例,可以使用cargo expand 。结果非常冗长,因此我们不在这里展示了。

将宏视为黑盒是可以接受的

当由库提供时,宏非常方便,但手动编写宏非常繁琐,因为它实际上需要解析 Rust 代码。

Rust 中不同类型的宏

我们提供的println!示例是一个函数式宏。Rust 还有其他类型的宏,但我们关心的另外两种是自定义派生宏属性式宏

让我们看一个由 anchor 创建的新程序:

img

我们将在接下来的教程中解释这些是如何工作的。

通过 RareSkills 了解更多

本教程是我们免费的 Solana 课程的一部分。