Rust cfg宏的用法和示例

在Rust中，cfg宏用于条件编译，允许根据不同的条件在编译代码时选择性地包含或排除特定的代码块；这对于处理不同平台、操作系统、编译器或其他环境变量的情况非常有用。

cfg 用法

cfg宏存在两种使用方式；

在代码块外使用

可以在整个模块或crate级别上使用#[cfg(...)]注解来决定整个模块或crate是否包含在编译中；

#[cfg(target_os = "windows")]
fn print_os(){
    println!("windows");
}

#[cfg(target_os = "linux")]
fn print_os(){
    println!("linux");
}

#[cfg(target_os = "macos")]
fn print_os(){
    println!("macos");
}

fn main() {
    print_os();
}

在这个例子中，会根据目标系统的不同选择性的编译不同版本的print_os()函数，这意味着虽然定义了3个print_os()函数，但只有一个会被编译；

在代码块内使用

通过使用cfg!宏来根据条件选择性的编译代码；cfg!会返回一个布尔值；

fn main() {

    if cfg!(target_os="windows"){
        println!("windows");
    }
    
}

使用cfg!宏不会编译整个分支；它只是用于在编译时查询指定条件是否为真，并且根据结果返回一个布尔值。这个宏在编译时用于静态地确定某些代码是否应该包含在最终地可执行文件中。

cfg 条件编译

cfg宏支持许多条件，包括目标操作系统版本、编译器版本、架构等，这里列举一些常用的：

• target_os：指定目标操作系统；
  • "windows"
  • "macos"
  • "ios"
  • "linux"
  • "android"
  • "freebsd"
  • "dragonfly"
  • "openbsd"
  • "netbsd"
• target_arch：指定目标CPU架构；
  • "x86"
  • "x86_x64"
  • "mips"
  • "powerpc"
  • "powerpc64"
  • "arm"
  • "aarch64"
• target_env：指定目标操作系统的执行环境；
• target_family：指定目标操作系统的家族；
  • "unix"
  • "windows"
  • "wsm"
• target_feature：指定目标CPU支持的特性；
• target_endian：编译目标的CPU字节序；
  • "little"
  • "big"
• unix，windows，macos：确定当前是否在特定操作系统下编译；
• debug_assertions：如果编译器在调试模式下，则启用该属性；
• feature：根据启用的特性进行条件编译；
• any，all，not：用于组合多个条件。any表示其中任意一个条件成立时执行，all表示所有条件都成立时执行，not表示条件取反；
• test：在编译测试套件时启用；