Rust 工具链

项目组织

• 基本的项目结构布局，通用的文件和文件夹，一般可由 cargo 生成

各种入口文件的小例子

// src/main.rs (程序的默认入口文件)

fn main() {
    println!("Hello, AwesomeProgram!");
}

// src/lib.rs (库的默认入口文件)

pub fn f() {}      // 因为是根目录中的公开目录，所以可从外部访问

mod m {
    pub fn g() {}  // 不是根目录中的公开路径(模块 m 不是公开的), 因此 g 不能在 crate 之外被访问
}  

// src/my_module.rs (单元测试可以在你项目中的任意文件)

fn f() -> u32 { 0 }

#[cfg(test)]
mod test {
    use super::f;           // 需要从上级模块中导入目录，可以访问没有公开的成员

    #[test]
    fn ff() {
        assert_eq!(f(), 0);
    }
}

// tests/sample.rs (集成测试的例子)

#[test]
fn my_sample() {
    assert_eq!(my_crate::f(), 123); // 集成测试和基准测试依赖第三方的 crate，因此，他们仅看到公开的目录
}

// benches/sample.rs (基准测试的例子)

#![feature(test)]   // 基准测试仍处于试验阶段

extern crate test;  // 在 2018 版本中需要添加

use test::{black_box, Bencher};

#[bench]
fn my_algo(b: &mut Bencher) {
    b.iter(|| black_box(my_crate::f())); // `black_box` 阻止 `f` 被优化掉
}

// build.rs (预构建脚本的例子)

fn main() {
    // 你需要依赖目标 OS 的环境变量，对于当前的 OS 可以表示 `#[cfg(...)]`
    let target_os = env::var("CARGO_CFG_TARGET_OS");
}

// src/lib.rs (过程宏的默认入口文件)

extern crate proc_macro;  // 显然需要像这样被导入

use proc_macro::TokenStream;

#[proc_macro_attribute]   // 可以作为 `#[my_attribute]` 被使用
pub fn my_attribute(_attr: TokenStream, item: TokenStream) -> TokenStream {
    item
}

// Cargo.toml

[package]
name = "my_crate"
version = "0.1.0"

[lib]
proc-macro = true

模块树和NameSpace导入的使用

1. 在类型和函数中，定义类型 X 和常量 X
2. 在类型和函数中，定义类型 X 和函数 X

• 在任何给定的作用域中，例如在一个模块中，每个名称空间只能存在一个项目
  • enum X {} 和 fn X() {} 可以共存
  • struct X; 和 const X 可以共存
• 使用 use my_mod::X; 时，所有被 X 调用的目录都会被导入

^{*由于命名约定,如 按照约定 fn 和 mod 是小写，并且大多数开发者不会把所有东西都命名为 X， 在通常情况下你不必担心这些类型，它们可以成为设计宏时的一个因素}

Cargo

^{*必须要被了解的命令和工具}

^*这里的 cargo build 你也可以打印 cargo b，并且 --release 意味着可以用 -r 代替

下面这些是可选的 rustup 组件，使用 rustup component add [tool] 安装它们

^*有更多可添加的 cargo 插件 点我查看

交叉编译

🔘检查目标系统是支持的

🔘通过 rustup target install X 安装不同目标系统的需求

🔘安装原生的工具链

从目标主机供应商获取(谷歌、苹果 ...)，可能并非在所有的主机都可用(如 在 Windows 上没有 iOS 的工具连)

一些工具链需要额外的构建步骤(如 安卓系统需要 make-standalone-toolchain.sh )

🔘像下面这样更新 ~/.cargo/config.toml

[target.aarch64-linux-android]
linker = "[PATH_TO_TOOLCHAIN]/aarch64-linux-android/bin/aarch64-linux-android-clang"

[target.aarch64-linux-android]
linker = "C:/[PATH_TO_TOOLCHAIN]/prebuilt/windows-x86_64/bin/aarch64-linux-android21-clang.cmd"

🔘设置环境变量(可选的，等待编译器如果有报错提示后再进行设置)

set CC=C:\[PATH_TO_TOOLCHAIN]\prebuilt\windows-x86_64\bin\aarch64-linux-android21-clang.cmd
set CXX=C:\[PATH_TO_TOOLCHAIN]\prebuilt\windows-x86_64\bin\aarch64-linux-android21-clang.cmd
set AR=C:\[PATH_TO_TOOLCHAIN]\prebuilt\windows-x86_64\bin\aarch64-linux-android-ar.exe
...

是否设置它们依赖于编译反馈的报错提示，不一定都是需要的

一些平台的配置可能会非常敏感，取决于如何指定路径(如 \ 与 / )和引用路径

✔️使用 cargo build --target=X 去编译

工具指令

^{*嵌入在源码中的特殊标记通常用于工具或者预处理}

^*对于属性中的On列：

• C 表示在 crate 级别（通常 #![my_attr] 在顶级文件中给出）
• M 意味着在模块上
• F 指功能上
• S 意味着静态
• T 表示类型
• X 意味着一些特殊的东西
• ! 意味着在宏上
• * 意味着几乎任何项目