Rust 宏笔记

本贴最后更新于 1762 天前,其中的信息可能已经沧海桑田


这篇文章说的是?

Rust 的宏。


宏按照来源分类:

声明宏(Declarative Macro)和过程宏(Procedural Macro)。前者指的是用某种语法直接声明出的宏。后者是对应直接生成抽象语法树的过程的宏。

直觉上过程宏更隐式,更全能;声明宏更可读,更直接。


如何定义声明宏?

现在用 macro_rules!。以后可能还有别的办法。


如何定义过程宏?

以后再说。


宏按照使用方式分类:

属性宏:给声明添加属性的宏,例如 #[derive(Debug)]#[test]

调用宏:像函数一样的宏,例如 println!


来源分类和使用方式分类之间的关系如何?

目前的声明宏都是用 macro_rules! 声明出的,它声明出的一定是调用宏。过程宏可以产生属性宏,也可以产生调用宏。

也就是说,属性宏都是过程宏,调用宏可能是声明宏或者过程宏。


println! 宏大概是什么样子?

macro_rules! println { () => (println!("\n")); ($fmt: expr) => (print!(concat!($fmt, "\n"))); ($fmt: expr, $($(arg:tt)*) => (print!(concat!($fmt, "\n"), $($arg)*)); }

这个宏有几部分?

有三个部分,输入分别是 ()($fmt:expr)($fmt: expr, $($args:tt)*),依次扩展成 => 后,圆括号内部的部分。每个部分是一条规则,每条规则以 ; 结尾。


=> 后的圆括号是必须的吗?

不能省略,但是可以换成 {} 或者 []


$fmt: expr 是什么?

$fmt 是对宏参数的捕获,类似于函数的参数。expr 表示这个捕获的类型是表达式,也就是会它会生成具体的值。具体到此处,它代表生成 println! 的格式字符串的表达式。


捕获有什么用?

宏的替换结果里可以用 $fmt 代表要替换这个捕获。例如 println!("Hello") 中,$fmt: expr 捕获了 "Hello",所以 print!(concat!($fmt, "\n)) 中的 $fmt 会被替换为 "Hello",所以展开成 print!(concat!("Hello", "\n"))


展开的宏中如果还有宏,还会继续展开吗?

会,上面 println! 展开之后的内容中有 print!concat!,它们都会再次展开。这是理所当然的行为,这个问题只是为了让 Rust 的宏跟 C++ 的宏划清界限。


都有什么捕获类型?

类型 意义
item 语言项,模块、定义、声明等
block 代码块,花括号限定的代码
stmt 语句,分号结尾的代码
expr 表达式,会生成具体的值
pat 模式
ty 类型
ident 标识符
path 路径,指从 crate 到 mod 的定位
meta 元信息
tt TokenTree 的缩写,词条树
vis 可见性,例如 pub
lifetime 生命周期参数

$($arg:tt)* 是什么意思?

单独看 $arg:tt 表示匹配一个词条树的捕获,在外面套上 $()* 表示匹配若干次词条树。


$($arg)* 是什么意思?

单看 $arg,表示在宏里替换捕获 $arg,外面套上 $()* 表示使用所有匹配的捕获。这个用法跟它的捕获语法是对应的。


$($arg:tt)* 能匹配什么?

println! 在第一个参数之后的所有东西。这个宏不止可以传递像函数一样的参数,还可以像 Python 那样传递命名参数,例如:

println!("Hello, {name}", name="Luna");

这样的参数 $($arg:tt)* 也能捕获到。


如果想只捕获(不定个数个)函数参数应该如何做?

$($arg: expr),* 或者 $($arg: expr,)*


这两个有什么不同?

后者也匹配逗号结尾的参数列表。

Rust 的函数参数列表最后可以添加逗号,也可以不加。如果想让宏表现的尽量接近函数,应该两种情况都处理。


举个例子。

macro_rules! hash_map { ($($key:expr => $value:expr),*) => {{ let mut map = ::std::collections::HashMap::new(); $( map.insert($key, $value); )* map }}; ($($key:expr => $value:expr),*) => (hash_map! ($($key => $value),*)); }

怎么使用?

let map = hash_map! (1 => "one", 2 => "two", 3 => "three");

如何获取宏可变参数的长度?

没有直接的办法,但可以想些技巧。

macro_rules! unit { ($($x:tt)*) => (()); } macro_rules! count { ($($x:expr),*) => (<[()]>::len(&[$(unit!($x)),*])); }

它是如何工作的?

unit! 接受任意什么东西,返回一个 unit(())。count! 宏把参数填给 unit!,构造了一个 unit 数组,数组长度就是参数的个数。

好处是,unit 不占空间,unit 的数组也是。


count! 宏需要 unit! 宏才能工作,但 unit! 宏本身没什么用,能不能把 unit! 变成私有的?

也没有直接的办法。基本上的技巧是换成一个比较难直接用到的规则:

macro_rules! count { (@unit $($x:tt)*) => (()); ($($x:expr),*) => (<[()]>::len(&[$(count!(@unit $x)),*])); }

要是有人非要写 count!(@unit ...),也没法阻止。但那个奇奇怪怪的 @ 已经暗示了这是一个内部实现,这就足够了。


#[macro_export] 有什么作用?

标记一个宏可以在其他包中使用。也就是说,默认情况下,宏不能在定义的包外使用。


#[macro_use] 有什么用?

在 Rust 2015 中,在外部包的声明语前,用它标记要导入另一个包的宏。另外,它还标记一个 mod 的宏可以在外面使用。


宏重名会怎样?

后导入的会覆盖先前导入的,不会发生错误。


$crate 有什么用?

它看起来像一个捕获,但不是在宏参数列表里捕获的。它会扩展成当前包的名字。需要这个捕获的原因是,当前包无法决定此包被其他包导入的时候,使用的是什么名字。所以如果要使用当前包的函数或者别的东西,就需要从 $crate 开始写路径。


完。

  • Rust

    Rust 是一门赋予每个人构建可靠且高效软件能力的语言。Rust 由 Mozilla 开发,最早发布于 2014 年 9 月。

    58 引用 • 22 回帖 • 10 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • 笔记

    好记性不如烂笔头。

    310 引用 • 794 回帖
  • Shell

    Shell 脚本与 Windows/Dos 下的批处理相似,也就是用各类命令预先放入到一个文件中,方便一次性执行的一个程序文件,主要是方便管理员进行设置或者管理用的。但是它比 Windows 下的批处理更强大,比用其他编程程序编辑的程序效率更高,因为它使用了 Linux/Unix 下的命令。

    124 引用 • 74 回帖 • 1 关注
  • CentOS

    CentOS(Community Enterprise Operating System)是 Linux 发行版之一,它是来自于 Red Hat Enterprise Linux 依照开放源代码规定释出的源代码所编译而成。由于出自同样的源代码,因此有些要求高度稳定的服务器以 CentOS 替代商业版的 Red Hat Enterprise Linux 使用。两者的不同在于 CentOS 并不包含封闭源代码软件。

    239 引用 • 224 回帖
  • Hibernate

    Hibernate 是一个开放源代码的对象关系映射框架,它对 JDBC 进行了非常轻量级的对象封装,使得 Java 程序员可以随心所欲的使用对象编程思维来操纵数据库。

    39 引用 • 103 回帖 • 722 关注
  • FlowUs

    FlowUs.息流 个人及团队的新一代生产力工具。

    让复杂的信息管理更轻松、自由、充满创意。

    1 引用 • 1 关注
  • SSL

    SSL(Secure Sockets Layer 安全套接层),及其继任者传输层安全(Transport Layer Security,TLS)是为网络通信提供安全及数据完整性的一种安全协议。TLS 与 SSL 在传输层对网络连接进行加密。

    70 引用 • 193 回帖 • 412 关注
  • BookxNote

    BookxNote 是一款全新的电子书学习工具,助力您的学习与思考,让您的大脑更高效的记忆。

    笔记整理交给我,一心只读圣贤书。

    1 引用 • 1 回帖
  • TGIF

    Thank God It's Friday! 感谢老天,总算到星期五啦!

    289 引用 • 4492 回帖 • 654 关注
  • 快应用

    快应用 是基于手机硬件平台的新型应用形态;标准是由主流手机厂商组成的快应用联盟联合制定;快应用标准的诞生将在研发接口、能力接入、开发者服务等层面建设标准平台;以平台化的生态模式对个人开发者和企业开发者全品类开放。

    15 引用 • 127 回帖
  • abitmean

    有点意思就行了

    36 关注
  • OneDrive
    2 引用
  • InfluxDB

    InfluxDB 是一个开源的没有外部依赖的时间序列数据库。适用于记录度量,事件及实时分析。

    2 引用 • 87 关注
  • V2EX

    V2EX 是创意工作者们的社区。这里目前汇聚了超过 400,000 名主要来自互联网行业、游戏行业和媒体行业的创意工作者。V2EX 希望能够成为创意工作者们的生活和事业的一部分。

    16 引用 • 236 回帖 • 266 关注
  • Rust

    Rust 是一门赋予每个人构建可靠且高效软件能力的语言。Rust 由 Mozilla 开发,最早发布于 2014 年 9 月。

    58 引用 • 22 回帖 • 9 关注
  • 浅吟主题

    Jeffrey Chen 制作的思源笔记主题,项目仓库:https://github.com/TCOTC/Whisper

    1 引用 • 28 回帖 • 2 关注
  • Anytype
    3 引用 • 31 回帖 • 14 关注
  • App

    App(应用程序,Application 的缩写)一般指手机软件。

    91 引用 • 384 回帖
  • ngrok

    ngrok 是一个反向代理,通过在公共的端点和本地运行的 Web 服务器之间建立一个安全的通道。

    7 引用 • 63 回帖 • 648 关注
  • TextBundle

    TextBundle 文件格式旨在应用程序之间交换 Markdown 或 Fountain 之类的纯文本文件时,提供更无缝的用户体验。

    1 引用 • 2 回帖 • 83 关注
  • SQLServer

    SQL Server 是由 [微软] 开发和推广的关系数据库管理系统(DBMS),它最初是由 微软、Sybase 和 Ashton-Tate 三家公司共同开发的,并于 1988 年推出了第一个 OS/2 版本。

    21 引用 • 31 回帖
  • JRebel

    JRebel 是一款 Java 虚拟机插件,它使得 Java 程序员能在不进行重部署的情况下,即时看到代码的改变对一个应用程序带来的影响。

    26 引用 • 78 回帖 • 678 关注
  • AWS
    11 引用 • 28 回帖 • 12 关注
  • RYMCU

    RYMCU 致力于打造一个即严谨又活泼、专业又不失有趣,为数百万人服务的开源嵌入式知识学习交流平台。

    4 引用 • 6 回帖 • 53 关注
  • 以太坊

    以太坊(Ethereum)并不是一个机构,而是一款能够在区块链上实现智能合约、开源的底层系统。以太坊是一个平台和一种编程语言 Solidity,使开发人员能够建立和发布下一代去中心化应用。 以太坊可以用来编程、分散、担保和交易任何事物:投票、域名、金融交易所、众筹、公司管理、合同和知识产权等等。

    34 引用 • 367 回帖 • 5 关注
  • Redis

    Redis 是一个开源的使用 ANSI C 语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value 数据库,并提供多种语言的 API。从 2010 年 3 月 15 日起,Redis 的开发工作由 VMware 主持。从 2013 年 5 月开始,Redis 的开发由 Pivotal 赞助。

    286 引用 • 248 回帖
  • Webswing

    Webswing 是一个能将任何 Swing 应用通过纯 HTML5 运行在浏览器中的 Web 服务器,详细介绍请看 将 Java Swing 应用变成 Web 应用

    1 引用 • 15 回帖 • 643 关注
  • uTools

    uTools 是一个极简、插件化、跨平台的现代桌面软件。通过自由选配丰富的插件,打造你得心应手的工具集合。

    7 引用 • 27 回帖