深入了解Rust的声明性标记

在Rust中，声明性标记是指放置在函数定义、模块、类型等上面的属性。它们提供额外的信息或改变代码的行为。Rust中的声明性标记以井号(#)开头，放在方括号([])内。例如，一个声明性标记可以表示成这样：#[attribute]。

声明性标记主要分为三大类：条件编译、crate-level属性以及函数和模块级属性。

条件编译

条件编译是通过属性控制的，允许有条件地编译部分代码。Rust通过两个关键属性来支持这一点：

1，cfg：此属性包含基于传递给编译器的标记代码。它可以在定义类型的地方使用，函数、实现块、结构体等。

#[cfg(target_os = "linux")]
fn are_you_on_linux() {
    println!("You're running linux!");
}

2，cfg_attr：此属性允许基于条件标记实现配置。

#[cfg_attr(feature = "debug-mode", derive(Debug))]
struct Test {
    value: i32,
}

在上面的代码中，只有在启用Debug模式时，才会为结构体Test派生Debug特征。

Crate-level属性

Crate级别的属性适用于整个crate，它们通常放在主文件(lib.rs或main.rs)的顶部。一些常用的crate级别的属性是：

1，crate_name：该属性允许手动设置crate的名称。

#![crate_name = "my_crate"]

2，crate_type：该属性允许定义crate的类型(库、二进制文件等)。

#![crate_type = "lib"]

3，deny，warn，allow，forbid：这些属性用于在crate级别处理警告或lint检查。

#![deny(missing_docs)]

4，macro_use：这个属性允许从外部crate中使用宏。

#[macro_use]
extern crate log;

函数和模块级属性

这些属性适用于函数、模块、结构、枚举、特征等。下面是一些常见的：

1，test：该属性将函数标记为单元测试。

#[test]
fn test_addition() {
    assert_eq!(2 + 2, 4);
}

2，derive：这个属性自动为用户定义的类型创建特征的实现。

#[derive(Debug)]
struct Point {
    x: i32,
    y: i32,
}

3，inline：该属性向编译器建议，它应该将函数代码的副本内联到其调用者，从而可能提高运行时性能。

#[inline]
fn add(x: i32, y: i32) -> i32 {
    x + y
}

4. deprecated：此属性可以表示不应该使用的代码项，并将在将来的版本中删除。

#[deprecated(since = "1.1.0", note = "请使用' new_function '代替")]
fn old_function() {
    // 
}

属性中的派生宏

特别要提一下派生属性，它允许Rust自动为结构体或枚举生成某些特征。默认情况下，Rust可以派生10种不同的特性：

• Clone
• Copy
• Debug
• Default
• Eq
• PartialEq
• Ord
• PartialOrd
• Hash
• Drop

#[derive(Debug, PartialEq, Eq)]
struct Point {
    x: i32,
    y: i32,
}

在本例中，Point结构体自动实现Debug、PartialEq和Eq特征。

过程宏中的属性宏

Rust还支持过程宏，包括属性宏。虽然在技术上不是属性，但它们的行为类似，可用于调整函数、结构体的行为。

属性宏的定义如下：

#[macro_name(attributes)]

这方面的一个例子是流行的serde库的派生宏：

#[derive(Serialize, Deserialize)]
struct Point {
    x: i32,
    y: i32,
}

在这个例子中，Serialize和Deserialize是过程宏中的属性宏，它们生成将Point实例转换为各种数据格式所需的代码。

文档属性

文档是任何代码库的一个基本方面，Rust通过属性提供了对文档的内置支持：

doc：这个属性允许在代码中为模块、函数、结构体、枚举、特征、类型等编写文档注释。

/// 这是下面结构体的文档注释。
#[doc = "表示二维空间中的一个点。"]
struct Point {
    x: i32,
    y: i32,
}

在这个例子中，doc属性用于为Point结构体生成文档。

死代码和未使用检测

Rust的属性系统还可以帮助防止常见的编码错误：

dead_code：此属性可用于对从未调用的代码消除警告。

#[allow(dead_code)]
fn unused_function() {
    // 
}

must_use：当函数的结果未被使用时，函数的这个属性将产生一个警告。

#[must_use]
fn function_with_important_result() -> i32 {
    // 
    return 42;
}

总结

声明性标记在塑造代码的行为和属性方面起着至关重要的作用。它们提供了元编程功能，允许开发人员用额外的信息或行为注释他们的程序。这种能力对于编程的许多方面都是必不可少的，包括测试、文档编写、优化、条件编译等。

本文由微信公众号coding到灯火阑珊原创，哈喽比特收录。
文章来源：https://mp.weixin.qq.com/s/X7SqXZM18ZuKIF0bsWJCew