专栏首页Rust语言学习交流【Rust每周一知】 Attribute 属性

【Rust每周一知】 Attribute 属性

属性是作用在 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。第一列是语法样式名称,第二列是语法看起来的样子。

Style

Example

MetaWord

no_std

MetaNameValueStr

doc = "example"

MetaListPaths

allow(unused, clippy::inline_always)

MetaListIdents

macro_use(foo, bar)

MetaListNameValueStr

link(name = "CoreFoundation", kind = "framework")

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

Active 和 insert 属性

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

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

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

  • cfgcfg_attr 属性是 active 的。
  • 当编译为 test 模式时,test 属性是 insert 的。编译为非 test 模式时,test 属性是 active 的。
  • 属性宏是 active 的。
  • 所有其它属性是 insert 的。

属性的分类

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

  1. Macro attributes - 宏属性
  2. Derive macro helper attributes - 派生宏辅助属性
  3. Tool attributes - 工具属性
  4. 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 @_@!!

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

  • 条件编译
    • cfg
    • cfg_attr
  • 测试
    • test
    • ignore
    • should_panic
  • 派生
    • derive
  • 宏相关
    • macro_export
    • macro_use
    • proc_macro
    • proc_macro_derive
    • proc_macro_attribute
  • 诊断
    • allow, warn, deny, forbid - lint 相关标志开关,各种 lint 见附录。
    • deprecated
    • must_use
  • ABI, 链接, 符号, 和 FFI
    • link
    • link_name
    • no_link
    • repr
    • crate_type
    • no_main
    • export_name
    • link_section
    • no_mangle
    • used
    • crate_name
  • 代码生成
    • inline
    • cold
    • no_builtins
    • target_feature
  • 文档
    • doc
  • 预引入
    • no_std
    • no_implicit_prelude
  • 模块
    • path
  • 限制
    • recursion_limit
    • type_length_limit
  • 运行时
    • panic_handler
    • global_allocator
    • windows_subsystem
  • 语言特性
    • feature - 经常会碰到这里面一些陌生的 feature 名称,需要根据具体的 rustc 版本和所使用的库文档进行查阅。
  • 类型系统
    • non_exhaustive

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

参考

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

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

本文分享自微信公众号 - Rust语言学习交流(rust-china),作者:Mike Tang

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-02-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【Rust日报】 2019-07-24:不同语言中的泛型和元编程模型

    async/await将在Rust 1.38中稳定,但是还不会支持trait中的异步方法,所以,dtolnay做了这个库,提供了一个属性宏#[async_tra...

    MikeLoveRust
  • 【Rust日报】 2020-02-13 在 VSCode 中调试 Rust 程序

    它是用 Rust 编写的实验性 Javascript 词法分析器,解析器和编译器。

    MikeLoveRust
  • 【Rust日报】 2019-08-15:欢迎使用最新的 async/await

    这不是闹着玩儿的操作系统了,这可是面向商业的正式的操作系统(一个 Linux 发行版)。官网地址在这里

    MikeLoveRust
  • ECMAScript中对象的两种属性

    1、数据属性 数据属性包含一个数据值的位置。这个位置可以读取和写入值。数据属性有4个描述其行为的特性。 [ [ Configurable ] ] 表示能否通过d...

    前端博客 : alili.tech
  • 达观数据前端分享:理解 JavaScript 中的对象的属性

    在达观数据的前端工作中,对象的属性是经常接触和使用的,正好最近重温了一下《JavaScript 高级程序设计》,把书中理解对象属性的部分整理一下与大家分享。 ...

    达观数据
  • 《OEA - 实体扩展属性系统 - 设计方案说明书》

        这篇设计文档是 12 月份写来参加公司的研发峰会的,自己倒是信心满满,不过最后还是没有入围。现在想想也没啥大用,所以贴出来,期待与园友交流。     文...

    用户1172223
  • 18.Swift学习之属性与方法

    YungFan
  • 前端基础-CSS属性选择器

    cwl_java
  • Workbook工作簿对象属性

    Activeworkbook.name表示当前活动工作簿的name属性,即当前excel文件的名称为vba.xlsm。

    无言之月
  • [UWP]依赖属性1:概述

    依赖属性(DependencyProperty)是UWP的核心概念,它是有DependencyObject提供的一种特殊的属性。由于UWP的几乎所有UI元素都是...

    dino.c

扫码关注云+社区

领取腾讯云代金券