Rust : Attribute 属性作者：Mike Tang

【Rust每周一知】 Attribute 属性
原创 Mike Tang Rust语言中文社区 3天前

属性是作用在 Rust 语言元素上的元数据。

Rust 中的属性数量非常多。而且具有可扩展性（可自定义属性）。Rust 的属性语法遵从 C# 定义并标准化了的属性规范ECMA-334。

Rust 代码中随处可见属性，有时甚至会多得让人摸不着头脑。本篇是对 Rust 中的属性相关知识的简单总结。水平有限，仅起到抛砖引玉的作用。
概念

整体来讲，属性还是比较好理解的，但是需要先理解一些基本概念：
Inner Attributes（内部属性）和 Outer Attributes（外部属性）

内部属性（Inner Attribute）是指：一个属性声明在一个元素中，对此元素（比如一般为 crate）整体生效。内部属性用 #![] 声明。

外部属性（Outer Attribute）是指：一个属性声明在一个元素之前，对跟在后面的这个元素生效。外部属性用 #[] 声明。

Rust 中，有些属性可以/只能作内部属性使用，有些属性可以/只能作外部属性使用。

Meta Item Attribute Syntax

Meta Item Attribute Syntax 实际上描述了属性语法的基本结构。

下面表格罗列了所有 Meta Item Attribute Syntax。第一列是语法样式名称，第二列是语法看起来的样子。

我们在 Rust 代码中看到的所有属性语法都是上述五种中的一种或其组合。

Active 和 insert 属性

一个属性，要么是 active 的，要么是 insert 的。

Active 属性是指，在处理属性（预处理代码）的过程中，active 属性会将它们自己删除，留下所作用的元素。

Insert 属性是指，在处理属性（预处理代码）的过程中，insert 属性会将它们自己保留。

cfg 和 cfg_attr 属性是 active 的。当编译为 test 模式时，test 属性是 insert 的。编译为非 test 模式时，test 属性是 active 的。属性宏是 active 的。所有其它属性是 insert 的。

属性的分类

Rust 中的属性，可以分为以下四大类。

Macro attributes - 宏属性Derive macro helper attributes - 派生宏辅助属性Tool attributes - 工具属性Built-in attributes - 内建属性

Macro Attributes 宏属性

宏属性，也叫属性宏。属于过程宏的一种。

定义过程宏的时候，使用 #[proc_macro_attribute]，加一个固定签名的函数（详见过程宏一章）。

#[proc_macro_attribute]
pub fn return_as_is(_attr: TokenStream, item: TokenStream) -> TokenStream {item
}

使用过程宏：

#[return_as_is]
fn invoke() {}

Derive macro helper attributes 派生宏辅助属性

派生宏辅助属性，听起来有点拗口，其实它是这样一个东西：

先定义派生宏

#[proc_macro_derive(HelperAttr, attributes(helper))]
pub fn derive_helper_attr(_item: TokenStream) -> TokenStream {
TokenStream::new()
}

看如何使用：

#[derive(HelperAttr)]
struct Struct {#[helper] field: ()
}

里面那个 #[helper] 就是一个派生宏辅助属性。

Tool Attributes 工具属性

工具属性。Rust 还允许外部工具定义它们自己的属性，并且在独立的命名空间下面。比如：

// Tells the rustfmt tool to not format the following element.
#[rustfmt::skip]
struct S {
}// Controls the "cyclomatic complexity" threshold for the clippy tool.
#[clippy::cyclomatic_complexity = "100"]
pub fn f() {}

不过如果你想在自己的工具中定义 Tool Attribute，那就想多了。现在 rustc 只认识两个外部工具（及它们内部的属性）：一个是 rustfmt，另一个是 clippy。

Built-in Attributes 内建属性

4 种属性的前面两种：宏属性和派生宏辅助属性，是可以完全自定义的。后面两种：工具属性和内建属性，我们只能用，不能自定义。

Rust 内建了 14 类属性。OMG @_@!!

每一个属性都有自己的用法，有的用法还比较多，可以用到的时候，再去查阅。这里简单罗列说明一下。

条件编译cfgcfg_attr测试testignoreshould_panic派生derive宏相关macro_exportmacro_useproc_macroproc_macro_deriveproc_macro_attribute诊断allow, warn, deny, forbid - lint 相关标志开关，各种 lint 见附录。deprecatedmust_useABI, 链接, 符号, 和 FFIlinklink_nameno_linkreprcrate_typeno_mainexport_namelink_sectionno_mangleusedcrate_name代码生成inlinecoldno_builtinstarget_feature文档doc预引入no_stdno_implicit_prelude模块path限制recursion_limittype_length_limit运行时panic_handlerglobal_allocatorwindows_subsystem语言特性feature - 经常会碰到这里面一些陌生的 feature 名称，需要根据具体的 rustc 版本和所使用的库文档进行查阅。类型系统non_exhaustive

上面的属性中，很多属性，其内容都可以单独开一篇文章来讲解。比如，条件编译相关的属性，FFI 相关属性等。
参考

本文内容主要来自：https://doc.rust-lang.org/reference/attributes.html。加入了作者的一些理解。各位同学有时间的话，最好将上述文档中的内容每一个都仔细过一遍。这样，需要用到的时候，温习一下就会用了。也并不是太难的事儿。

Unstable Book 对 rustc 的 flags 和各种 features 都做了详细的说明。

Rust : Attribute 属性作者：Mike Tang相关推荐

C#里Attribute属性
系统内置属性系统内置的Attribute属性Obsolete,被个这属性标记的方法在别的地方被调用的时候会有警告提示; 这个属性还可以指定第二个布尔参数,设置编译时是否报错; 例: 1 [Obsol ...
attribute属性
attribute属性 __attribute__介绍 attribute的格式. __attribute__((attribute-list)) attribute属性可以在编译的时候告诉编译器函数 ...
java attribute属性_[Java教程]JS Attribute属性操作
[Java教程]JS Attribute属性操作 0 2016-05-19 00:00:05 Attribute是属性的意思,文章仅对部分兼容IE和FF的Attribute相关的介绍. attribu ...
通过声明Attribute属性改变不同类的输出效果
ConsoleApplication--控制台应用程序首先创建基类: using System; using System.Collections.Generic; using System.Lin ...
[Wordpress]wp_dropdown_categories() 添加自定义的attribute(属性)
通过Wordpress wp_dropdown_categories()可以获取到Wordpress中的分类列表,假如需要添加一些Html5属性,如required,在看了这个方法的文档说明,没有参数 ...
Attribute 属性
https://www.cnblogs.com/ldyblogs/p/attribute.html 例子 https://www.cnblogs.com/luckdv/articles/Atrribu ...
三类常见软件质量(Quality Attribute)属性的通俗解释
外部质量用户关心正确性,最最基本的质量属性,对应功能需求,其他QA多对应非功能需求. 健壮性,在异常情况下正常运行的能力. 包含容错能力和恢复能力.恢复没有容错健壮. 可靠性,用平均无bug运行时 ...
敏捷宣言和企业Scrum作者Mike Beedle去世
\ 看新闻很累?看技术新闻更累?试试下载InfoQ手机客户端,每天上下班路上听新闻,有趣还有料! \ \\ 敏捷软件开发宣言发起者之一.企业Scrum开发方法论发明者Mike Beedle去世,留下了 ...
为什么Rust连续4年获“最受喜爱编程语言”？
作者 | Mike Tang 责编 | Aholiab 出品 | 区块链大本营(blockchain_camp) 2015年5月15日,Rust编程语言核心团队正式宣布发布Rust 1.0版本. 4年 ...
为什么 Rust 连续 4 年获「最受喜爱编程语言」？
作者 | Mike Tang 责编 | Aholiab 出品 | 区块链大本营(blockchain_camp) 2015年5月15日,Rust编程语言核心团队正式宣布发布Rust 1.0版本. 4年 ...

Rust : Attribute 属性作者：Mike Tang

Rust : Attribute 属性作者：Mike Tang相关推荐

最新文章

热门文章

Rust : Attribute 属性 作者：Mike Tang

Rust : Attribute 属性 作者：Mike Tang相关推荐

最新文章

热门文章

Rust : Attribute 属性作者：Mike Tang

Rust : Attribute 属性作者：Mike Tang相关推荐