Rust编译器配置工具rustc-cfg的使用指南

rustc-cfg是Rust编译器提供的一个强大功能，允许开发者在编译时进行条件判断和自定义构建配置。它主要通过#[cfg]属性来实现条件编译，并通过编译器参数来传递自定义配置。

基本用法

1. 条件编译

#[cfg(target_os = "linux")]
fn linux_only_function() {
    println!("This will only compile on Linux!");
}

#[cfg(not(target_os = "linux"))]
fn non_linux_function() {
    println!("This will compile on non-Linux systems!");
}

2. 自定义配置标志

可以在代码中使用自定义标志：

#[cfg(feature = "my_feature")]
fn feature_specific_code() {
    println!("This code is only included when 'my_feature' is enabled");
}

然后在Cargo.toml中启用：

[features]
my_feature = []

或者通过命令行启用：

cargo build --features my_feature

高级用法

1. 通过编译器参数传递自定义配置

rustc --cfg some_custom_config main.rs

然后在代码中使用：

#[cfg(some_custom_config)]
fn custom_config_function() {
    println!("This is only compiled with the custom config");
}

2. 组合条件

#[cfg(all(unix, not(target_os = "macos")))]
fn unix_but_not_macos() {
    println!("Running on Unix, but not macOS");
}

#[cfg(any(windows, target_os = "macos"))]
fn windows_or_macos() {
    println!("Running on Windows or macOS");
}

3. 条件编译结构体和模块

#[cfg(feature = "network")]
mod network {
    pub fn connect() {
        println!("Connecting to network...");
    }
}

#[cfg(test)]
mod tests {
    #[test]
    fn test_something() {
        assert_eq!(2 + 2, 4);
    }
}

实际应用示例

示例1：平台特定代码

#[cfg(target_os = "windows")]
fn get_os_name() -> &'static str {
    "Windows"
}

#[cfg(target_os = "linux")]
fn get_os_name() -> &'static str {
    "Linux"
}

#[cfg(target_os = "macos")]
fn get_os_name() -> &'static str {
    "macOS"
}

fn main() {
    println!("Running on {}", get_os_name());
}

示例2：特性开关

#[cfg(feature = "logging")]
fn log_message(msg: &str) {
    println!("LOG: {}", msg);
}

#[cfg(not(feature = "logging"))]
fn log_message(_msg: &str) {
    // 空实现，当logging特性禁用时不执行任何操作
}

fn main() {
    log_message("Application started");
}

完整示例demo

下面是一个结合了多种rustc-cfg用法的完整示例：

// 平台检测模块
mod platform {
    // 检测是否为调试模式
    #[cfg(debug_assertions)]
    pub fn is_debug() -> bool {
        true
    }
    
    #[cfg(not(debug_assertions))]
    pub fn is_debug() -> bool {
        false
    }
    
    // 检测操作系统类型
    #[cfg(target_os = "windows")]
    pub fn os_type() -> &'static str {
        "Windows"
    }
    
    #[cfg(target_os = "linux")]
    pub fn os_type() -> &'static str {
        "Linux"
    }
    
    #[cfg(target_os = "macos")]
    pub fn os_type() -> &'static str {
        "macOS"
    }
    
    // 检测CPU架构
    #[cfg(target_arch = "x86_64")]
    pub fn cpu_arch() -> &'static str {
        "x86_64"
    }
    
    #[cfg(target_arch = "arm")]
    pub fn cpu_arch() -> &'static str {
        "ARM"
    }
}

// 特性模块
#[cfg(feature = "network")]
mod network {
    pub fn connect() -> bool {
        println!("Network connected");
        true
    }
}

fn main() {
    println!("当前系统信息:");
    println!("操作系统: {}", platform::os_type());
    println!("CPU架构: {}", platform::cpu_arch());
    println!("调试模式: {}", platform::is_debug());
    
    #[cfg(feature = "network")]
    {
        if network::connect() {
            println!("网络连接成功");
        }
    }
    
    #[cfg(not(feature = "network"))]
    {
        println!("网络功能未启用");
    }
}

对应的Cargo.toml配置：

[package]
name = "cfg_demo"
version = "0.1.0"
edition = "2021"

[features]
network = []

这个完整示例展示了：

1. 使用debug_assertions检测调试模式
2. 使用target_os检测操作系统类型
3. 使用target_arch检测CPU架构
4. 使用自定义network特性开关
5. 模块级的条件编译

可以通过以下方式运行不同配置：

# 普通运行
cargo run

# 启用network特性
cargo run --features network

# 发布模式运行
cargo run --release